# LA2

## LAS

### PPL

#### SA2XT

##### ACTRL

###### AO_1

Instance id: | LAS_PPL_SA2XT/ACTRL/AO_1
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### AO_2

Instance id: | LAS_PPL_SA2XT/ACTRL/AO_2
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### AO_3

Instance id: | LAS_PPL_SA2XT/ACTRL/AO_3
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### AO_4

Instance id: | LAS_PPL_SA2XT/ACTRL/AO_4
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

##### ASENS

###### AI_1

Instance id: | LAS_PPL_SA2XT/ASENS/AI_1
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### AI_2

Instance id: | LAS_PPL_SA2XT/ASENS/AI_2
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### AI_3

Instance id: | LAS_PPL_SA2XT/ASENS/AI_3
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### AI_4

Instance id: | LAS_PPL_SA2XT/ASENS/AI_4
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### HYGROMETER_SPARE_SIG

Instance id: | LAS_PPL_SA2XT/ASENS/HYGROMETER_SPARE_SIG
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### HYGROMETER_SPARE_TEMP

Instance id: | LAS_PPL_SA2XT/ASENS/HYGROMETER_SPARE_TEMP
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

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

###### 24V_OUTPUT_1

Instance id: | LAS_PPL_SA2XT/DCTRL/24V_OUTPUT_1
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### 24V_OUTPUT_2

Instance id: | LAS_PPL_SA2XT/DCTRL/24V_OUTPUT_2
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### 5V_OUTPUT_1

Instance id: | LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_1
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Timing-changes-800nm, Timing-changes-800nm
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### 5V_OUTPUT_2

Instance id: | LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_2
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Timing-changes-800nm
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

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

###### LINSTAGE_SPARE_1

Instance id: | LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

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

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LINSTAGE_SPARE_2

Instance id: | LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

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

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LINSTAGE_SPARE_3

Instance id: | LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_3
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

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

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LINSTAGE_SPARE_4

Instance id: | LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_4
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

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

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTCMCOMPSTAGE

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTCMCOMPSTAGE
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CM-test, RF-Signal, cmStageMotor
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTDMCOMPSTAGE

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTDMCOMPSTAGE
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | EXPdmRFSignal
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTDRIFTSPARE1

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTDRIFTSPARE1
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTDRIFTSPARE2

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTDRIFTSPARE2
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTTRACYCOMPSPARE1

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMPSPARE1
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTTRACYCOMPSPARE2

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMPSPARE2
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTTRACYCOMP_MID_1

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMP_MID_1
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SMARACTTRACYCOMP_MID_2

Instance id: | LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMP_MID_2
Class id: | BeckhoffMC2Base
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Warning

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

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

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

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

Documentation can also be found for the derived soft devices:

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

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- AInternalSetpoint:
    Removed after 4.5.0-2.10.0
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

##### SWITCH

###### DI_1

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### DI_2

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### DI_3

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### DI_4

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

##### VALVE

###### PUMPLINE

Instance id: | LAS_PPL_SA2XT/VALVE/PUMPLINE
Class id: | BeckhoffValve
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### SPARE

Instance id: | LAS_PPL_SA2XT/VALVE/SPARE
Class id: | BeckhoffValve
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

## BSTAB

[add component documentation]

### TEST

[add component documentation]

#### MDL

[add component documentation]

##### TEST

## LA2

### LAS

#### PPL

##### CAM

###### AMPHOS_FF

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### AMPHOS_INPUT_NF

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### AMPHOS_NF

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### AC_XF1_DIAG

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### AC_XF2_DIAG

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### FE_XF1_FF

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### FE_XF1_NF

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### FE_XF2_NF

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### NOPA_1

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### NOPA_2

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### NOPA_SEED

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### TELESCOPE_CAM

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### TEM_XF1_FF

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### 1030_CAM

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### NOPA_3

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

###### BEAMPIPE

###### AMPHOS_SIDEPORT

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### PLC

###### COM

Instance id: | LA2_LAS_PPL/PLC/COM
Class id: | BeckhoffCom
Host: | la2-rr-ppl-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

###### COM_PLCMON

Instance id: | LA2_LAS_PPL/PLC/COM_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

##### PROC

###### AMPHOS_FF

Instance id: | LA2_LAS_PPL/PROC/AMPHOS_FF
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | Diagnostics, CAM/AMPHOS_FF, Status, CAM/Status, Diagnostics, CAM/AMPHOS_FF, CAM-AMPHOS_FF
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.

###### AMPHOS_INPUT_NF

Instance id: | LA2_LAS_PPL/PROC/AMPHOS_INPUT_NF
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM/AMPHOS_INPUT_NF, CAM-AMPHOS_INPUT_NF, FE_XF1-Pointing, FE_XF1-Cam-Images, Status, CAM/Status
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.

###### AMPHOS_NF

Instance id: | LA2_LAS_PPL/PROC/AMPHOS_NF
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM-AMPHOS_NF, Diagnostics, CAM/AMPHOS_NF, Status, CAM/Status, Diagnostics, CAM/AMPHOS_NF
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.

###### AC_XF2_DIAG

Instance id: | LA2_LAS_PPL/PROC/AC_XF2_DIAG
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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

###### FE_XF1_FF

Instance id: | LA2_LAS_PPL/PROC/FE_XF1_FF
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FE_XF1-Pointing, FE_XF1-Cam-Images, Status, CAM/Status, CAM/FE_XF1_FF
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.

###### FE_XF1_NF

Instance id: | LA2_LAS_PPL/PROC/FE_XF1_NF
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM/FE_XF1_NF, FE_XF1-Pointing, FE_XF1-Cam-Images, FE_XF1-NF-Output, Status, CAM/Status
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.

###### FE_XF2_NF

Instance id: | LA2_LAS_PPL/PROC/FE_XF2_NF
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | FE_XF2-NF-Output, FE_XF2-NF-Output
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.

###### NOPA_1

Instance id: | LA2_LAS_PPL/PROC/NOPA_1
Class id: | ImageProcessor
Host: | exflcon217
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-3
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: | NOPA-1st-stage
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.

###### NOPA_2

Instance id: | LA2_LAS_PPL/PROC/NOPA_2
Class id: | ImageProcessor
Host: | exflcon217
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-3
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: | NOPA-2nd-stage
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.

###### NOPA_SEED

Instance id: | LA2_LAS_PPL/PROC/NOPA_SEED
Class id: | ImageProcessor
Host: | exflcon217
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-3
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: | NOPA_SEED, TEM_XF2, XF2_Seeder_Cam, XF2_NOPA_SEED
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.

###### TELESCOPE_CAM

Instance id: | LA2_LAS_PPL/PROC/TELESCOPE_CAM
Class id: | ImageProcessor
Host: | exflcon217
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-3
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: | XF1-cams
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.

###### XF1_DIAG

Instance id: | LA2_LAS_PPL/PROC/XF1_DIAG
Class id: | ImageProcessor
Host: | exflcon217
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-3
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: | XF1-cams
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.

###### 1030_CAM

Instance id: | LA2_LAS_PPL/PROC/1030_CAM
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | 1030-output, 1030-Status-Scene
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.

###### NOPA_3

Instance id: | LA2_LAS_PPL/PROC/NOPA_3
Class id: | ImageProcessor
Host: | exflcon217
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-3
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: | NOPA-3rd-stage, Laser-status-scene, Laser-status-scene_HED
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.

###### TEM_XF1_FF

Instance id: | LA2_LAS_PPL/PROC/TEM_XF1_FF
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | TEM_XF1
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.

###### BOBCAT

Instance id: | LA2_LAS_PPL/PROC/BOBCAT
Class id: | ImageProcessor
Host: | exflcon218
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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

###### BEAMPIPE

Instance id: | LA2_LAS_PPL/PROC/BEAMPIPE
Class id: | ImageProcessor
Host: | la2-rr-ppl-con-3
Class documentation:
| ImageProcessor
Alias: | la2-rr-ppl-con-3
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.

##### SPECPROC

###### SEEDER_SPECTROMETER

###### NOPA_1

###### NOPA_2

###### NOPA_3

##### SPECT

###### SEEDER_SPECTROMETER

###### NOPA_1

###### NOPA_2

###### NOPA_3

##### TSYS

###### TIMESERVER

Instance id: | LA2_LAS_PPL/TSYS/TIMESERVER
Class id: | TimeServer
Host: | la2-las-sys-utc-1
Class documentation:
| TimeServer
Alias: | la2-las-sys-utc-1-mch
Git repo: | https://git.xfel.eu/karaboDevices/timeServer
Last modified: | 2021-09-14T08:39:06.351+02:00
Created at: | 2016-12-02T14:04:29.000+01:00
Main authors: | Hauf, Haufs, Fabbri
Latest tag: | 2.8.1-2.11.1
Deployment tag: | 2.8.1-2.11.1
Installed tag: | 2.8.1-2.11.1
Scenes: | Timing-changes-800nm, Timing-changes-800nm
Accessible by: | CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Time Server Documentation

The `Time Server` device is documented in timeServer:timeServer

Time Server Troubleshooting

To troubleshooting documentation

TrainId Workflow and Entities

To Train Id workflow documentation

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- reset:
    Resets the device in case of an error
- id:
    Most recently published actual trigger ID
- periodActual:
    Most recently published actual period of the ID value increment
- idDiff:
    Difference of ID and its previously published value divided by tick factor
- source:
    Select source of trigger ID as an URI (‘local://internal’, ‘local://x2timer’, or ‘tcp://host:port’)
- devfile:
    Local device file to be used if “local://x2timer” was selected
- periodSet:
    Setpoint for the period of the ID value increment (used only for internally generated ID)
- minPeriod:
    Minimum period value to emit a signal.
- maxPeriod:
    Maximum period value to emit a signal.
- badTrainIdsCounter:
    Counter for non increasing trainId events. Maxes out at 100
- badPeriodsCounter:
    Number of times in a tick factor where the period has been set to 0
- badPeriods:
    Last periods out of bounds
- readBunchPatternTable:
    This flag enables the reading of bunch pattern table. To get the full bunch pattern tables with every train use the ‘Full Bunch Pattern Table Updates’ flag.
- bunchPatternTable:
    Is only output if both the ‘readBunchPatternTable’ and ‘fullBunchPatternUpdates’ flags are set.
- fullBunchPatternUpdates:
    If set to true the full bunch pattern table will be updated for each train and logged.
- outputBunchPattern:
    Output channel to which bunch pattern updates are sent. Bunch patterns are only output if the ‘readBunchPatternTable’ is set.

Release History
2.8.1-2.11.1

Created: | 2021-02-10T16:51:00.000+01:00
Author: | Gabriele Giovanetti
Notes: | ‘update-copied-headers’ into ‘master’

2.8.0-2.10.0

Created: | 2021-02-05T11:41:17.000+01:00
Author: | Gero Flucke
Notes: | Fix bugs on period, C++14, fix CI

2.7.6-2.10.0

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

2.7.5-2.9.1

Created: | 2020-09-21T14:07:33.000+02:00
Author: | Alessandro Silenzi
Notes: | Skip ticks with bad periods and added a bunch of instrumentation

2.7.4-2.9.1

Created: | 2020-08-17T11:38:17.000+02:00
Author: | Riccardo Fabbri
Notes: | PatternTable array moved into data node of output channel for DAQ compatibility.

2.7.3-2.9.1

Created: | 2020-07-22T16:18:32.000+02:00
Author: | Riccardo Fabbri
Notes: | Added slot for toggling data processing.

2.7.2-2.9.1

Created: | 2020-07-08T22:40:51.000+02:00
Author: | Riccardo Fabbri
Notes: | PplBunchPatternStats: Node maxBufferLength is reconfigurable.

2.7.1-2.9.1

Created: | 2020-06-26T19:26:19.000+02:00
Author: | Riccardo Fabbri
Notes: | Derive from BunchPattern digest a class with the metrics for PPL bits.

2.7.0-2.9.0

Created: | 2020-05-27T15:47:21.000+02:00
Author: | Steffen Hauf
Notes: |

2.7.0-2.9

Created: | 2020-05-27T15:47:21.000+02:00
Author: | Steffen Hauf
Notes: | Bunch patterns as digests, add a BunchPatternStats device

2.6.0-2.7

Created: | 2020-02-12T15:34:09.000+01:00
Author: | Gero Flucke
Notes: | Introduce average difference of id increase and add alarms to it

2.5.3-2.4.0

Created: | 2019-05-07T16:35:38.000+02:00
Author: | Alessandro Silenzi
Notes: | Avoid System Crashes on multiple instances

2.5.2-2.3.3

Created: | 2019-01-23T10:01:43.000+01:00
Author: | Alessandro Silenzi
Notes: | FEAT: avoid namespace collision with pcLayer

2.5.1-2.3.0

Created: | 2018-12-10T14:26:22.000+01:00
Author: | Alessandro Silenzi
Notes: | added DAQ Policy

2.5.0-2.2.6

Created: | 2018-11-29T16:54:33.000+01:00
Author: | Alessandro Silenzi
Notes: | Added read Bunch Pattern table feature

2.4.0-2.1.15

Created: | 2018-02-27T11:18:55.000+01:00
Author: | Gero Flucke
Notes: | Publish signalled trainIds to data logger

2.3.2-2.1.15

Created: | 2017-09-14T15:41:19.000+02:00
Author: | Sergey Esenov
Notes: | Fix SIGFPE in signalHandler

2.3.1-2.1.15

Created: | 2017-08-25T10:54:38.000+02:00
Author: | Sergey Esenov
Notes: | Use timing from timing board with the following priority: ‘master’, ‘global’ or ‘board’ to avoid zero values.

2.3.0-2.1.15

Created: | 2017-08-20T14:55:53.000+02:00
Author: | Sergey Esenov
Notes: |

2.2.0-2.1.12

Created: | 2017-06-12T15:43:27.000+02:00
Author: | esenov
Notes: |

###### TIMESERVER_BSTATS_PPL

##### ACTRL

###### GUIDELASER_EXP_1_CTL_OUT

Instance id: | LA2_LAS_PPL/ACTRL/GUIDELASER_EXP_1_CTL_OUT
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### GUIDELASER_EXP_2_CTL_OUT

Instance id: | LA2_LAS_PPL/ACTRL/GUIDELASER_EXP_2_CTL_OUT
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### HYGROMETER_1_HUMIDITY

Instance id: | LA2_LAS_PPL/ACTRL/HYGROMETER_1_HUMIDITY
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest 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-and-Humidity
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### HYGROMETER_1_TEMPERATURE

Instance id: | LA2_LAS_PPL/ACTRL/HYGROMETER_1_TEMPERATURE
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest 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-and-Humidity
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INPUT1

Instance id: | LA2_LAS_PPL/ACTRL/INPUT1
Host: | exflcon144
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-12-18T15:47:36.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Giovanetti, Silenzi, Goeries
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### INPUT2

Instance id: | LA2_LAS_PPL/ACTRL/INPUT2
Host: | exflcon144
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-12-18T15:47:36.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Giovanetti, Silenzi, Goeries
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### INPUT3

Instance id: | LA2_LAS_PPL/ACTRL/INPUT3
Host: | exflcon144
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-12-18T15:47:36.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Giovanetti, Silenzi, Goeries
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### INPUT4

Instance id: | LA2_LAS_PPL/ACTRL/INPUT4
Host: | exflcon144
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-12-18T15:47:36.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Giovanetti, Silenzi, Goeries
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf

###### BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

###### OUTPUT_1

Instance id: | LA2_LAS_PPL/ACTRL/OUTPUT_1
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUTPUT_2

Instance id: | LA2_LAS_PPL/ACTRL/OUTPUT_2
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUTPUT_3

Instance id: | LA2_LAS_PPL/ACTRL/OUTPUT_3
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### OUTPUT_4

Instance id: | LA2_LAS_PPL/ACTRL/OUTPUT_4
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### 1

Instance id: | LA2_LAS_PPL/ADC/1
Class id: | FastAdc
Host: | la2-las-sys-utc-1
Class documentation:
| FastAdc
Alias: | la2-las-sys-utc-1-mch
Git repo: | https://git.xfel.eu/karaboDevices/fastAdc
Last modified: | 2021-10-05T11:19:39.976+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Hauf, Mamchykd, Fernands
Latest tag: | 2.8.6-2.11.1
Deployment tag: | 2.8.6-2.11.1
Installed tag: | 2.8.6-2.11.1
Scenes: | Raw-Data, test, dmBCCRAWDATA, ADC1_TEST, CM-test, EXPdmRFSignal, RF-Signal, ADC1_TEST
Accessible by: | CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, 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

###### 3

Instance id: | LA2_LAS_PPL/ADC/3
Class id: | FastAdc
Host: | la2-las-sys-utc-1
Class documentation:
| FastAdc
Alias: | la2-las-sys-utc-1-mch
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/fastAdc
Last modified: | 2021-06-25T13:32:26.000+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Fernandes, Ehsan, Ehsanw
Latest tag: | 2.8.3-2.11.1
Deployment tag: | 2.8.3-2.11.1
Installed tag: | 2.8.3-2.11.1
Scenes: | test
Accessible by: | CONTROLS, CTRL, DET, babies, kaned, tjezynsk, 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”).
- timeAxis:
    Time of sample (relative to trigger signal).
- rawDataMode:
    Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.
- rawDynamic:
    When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.
- triggerTime:
    Time between Triggers
- trainId:
    Current train ID as read from the FPGA
- timingSync:
    Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System
- sampleFirstBunch:
    Sample number of the first bunch
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- bunchPatternNode:
    Set up bunch pattern decoding parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters

Release History
2.8.3-2.11.1

Created: | 2021-06-25T11:42:45.000Z
Author: | Gabriele Giovanetti
Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created: | 2021-06-15T17:42:44.000Z
Author: | Wajid Ehsan
Notes: | Fix bunch period issue

2.8.1-2.11.1

Created: | 2021-06-15T16:00:03.000Z
Author: | Wajid Ehsan
Notes: | Update depends tag

2.8.0-2.11.1

Created: | 2021-06-11T14:21:15.000Z
Author: | Bruno Fernandes
Notes: | FastADC firmware 3.5.21

2.7.8-2.11.1

Created: | 2021-06-09T09:37:55.000Z
Author: | Wajid Ehsan
Notes: | update tag for iibus

2.7.7-2.11.1

Created: | 2021-06-02T16:15:10.000Z
Author: | Wajid Ehsan
Notes: | Fix indentation issues

2.7.6-2.10.0

Created: | 2021-06-02T07:25:59.000Z
Author: | Bruno Fernandes
Notes: | Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created: | 2021-02-04T13:52:10.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created: | 2020-11-26T11:52:36.000Z
Author: | Steffen Hauf
Notes: | Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created: | 2020-11-24T13:31:13.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

2.7.3-2.9.1

Created: | 2020-09-23T15:43:01.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created: | 2020-09-11T14:25:10.000Z
Author: | Wajid Ehsan
Notes: | Remove deprecated slots

2.7.1-2.9.0

Created: | 2020-09-10T08:12:17.000Z
Author: | Robert Schaffer
Notes: | For Firmware version 3.5

2.7.0-2.9.0

Created: | 2020-09-09T17:36:37.000Z
Author: | Robert Schaffer
Notes: |

2.6.4-2.6.1-only_for_laslab

Created: | 2019-11-26T12:38:00.000Z
Author: | Riccardo Fabbri
Notes: | Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created: | 2019-11-12T12:27:17.000Z
Author: | Denys Mamchyk
Notes: | fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created: | 2019-07-11T07:56:32.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected

2.6.1-2.4.0

Created: | 2019-06-20T11:01:02.000Z
Author: | Steffen Hauf
Notes: |

2.6.0-2.4.0

Created: | 2019-06-03T10:58:20.000Z
Author: | Steffen Hauf
Notes: | Add the fasterADC device, which only outputs raw data

2.5.0-2.4.0

Created: | 2019-05-02T15:15:13.000Z
Author: | Alessandro Silenzi
Notes: | FIX: avoid sending old data if RAW not ready Documentation

##### ASENS

###### EMETER_AMPHOS_DIAG

###### GUIDELASER_EXP_1_MOD_IN

Instance id: | LA2_LAS_PPL/ASENS/GUIDELASER_EXP_1_MOD_IN
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### GUIDELASER_EXP_2_MOD_IN

Instance id: | LA2_LAS_PPL/ASENS/GUIDELASER_EXP_2_MOD_IN
Class id: | BeckhoffAnalogOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

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

###### EMETER_1030

###### EMETER_NOPA_3

###### INPUT1

Instance id: | LA2_LAS_PPL/ASENS/INPUT1
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INPUT2

Instance id: | LA2_LAS_PPL/ASENS/INPUT2
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INPUT3

Instance id: | LA2_LAS_PPL/ASENS/INPUT3
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INPUT4

Instance id: | LA2_LAS_PPL/ASENS/INPUT4
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### GENTEC_EMETER_AMPHOS

###### GENTEC_EMETER_NOPA

##### DCTRL

###### CHILLER_REMOTESTART

Instance id: | LA2_LAS_PPL/DCTRL/CHILLER_REMOTESTART
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### GUIDELASER_EXP_1_LD_REM

Instance id: | LA2_LAS_PPL/DCTRL/GUIDELASER_EXP_1_LD_REM
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### GUIDELASER_EXP_2_LD_REM

Instance id: | LA2_LAS_PPL/DCTRL/GUIDELASER_EXP_2_LD_REM
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BEAMPIPES_ON

Instance id: | LA2_LAS_PPL/DCTRL/BEAMPIPES_ON
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | VacuumMonitoring, LA2_LAS_PPL/VACUUM/CONTROL|default, LA2_LAS_PPL/VACUUM/CONTROL|default
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### CMCOMPSTAGE

Instance id: | LA2_LAS_PPL/ENC/CMCOMPSTAGE
Class id: | BeckhoffEncoder
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | dmStageMotor, cmStageMotor
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### DMCOMPSTAGE

Instance id: | LA2_LAS_PPL/ENC/DMCOMPSTAGE
Class id: | BeckhoffEncoder
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### NANOSSPARE1

Instance id: | LA2_LAS_PPL/ENC/NANOSSPARE1
Class id: | BeckhoffEncoder
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### NANOSSPARE2

Instance id: | LA2_LAS_PPL/ENC/NANOSSPARE2
Class id: | BeckhoffEncoder
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### NANOSSPARE2_2

Instance id: | LA2_LAS_PPL/ENC/NANOSSPARE2_2
Class id: | BeckhoffEncoder
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### TRACEYCOMP_EXP

Instance id: | LA2_LAS_PPL/ENC/TRACEYCOMP_EXP
Class id: | BeckhoffEncoder
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### TRACEYCOMP_EXP_2

Instance id: | LA2_LAS_PPL/ENC/TRACEYCOMP_EXP_2
Class id: | BeckhoffEncoder
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- value:
    Encoder read value
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- offset:
    Linear offset for analog value.
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### GAUGE

###### BEAMPIPE_EXP_1

Instance id: | LA2_LAS_PPL/GAUGE/BEAMPIPE_EXP_1
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | LA2_LAS_PPL/VACUUM/CONTROL|default, VacuumMonitoring, LA2_LAS_PPL/VACUUM/CONTROL|default, LA2_LAS_PPL/VACUUM/CONTROL|default
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BEAMPIPE_EXP_2

Instance id: | LA2_LAS_PPL/GAUGE/BEAMPIPE_EXP_2
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### CYLLENS_EXP_FA

Instance id: | LA2_LAS_PPL/MOTOR/CYLLENS_EXP_FA
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CYLLENS_EXP_SA

Instance id: | LA2_LAS_PPL/MOTOR/CYLLENS_EXP_SA
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CYL_LENS_STAGE_1

Instance id: | LA2_LAS_PPL/MOTOR/CYL_LENS_STAGE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CYL_LENS_STAGE_2

Instance id: | LA2_LAS_PPL/MOTOR/CYL_LENS_STAGE_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LINEAR_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/LINEAR_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LINEAR_SPARE_2

Instance id: | LA2_LAS_PPL/MOTOR/LINEAR_SPARE_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LINEAR_SPARE_3

Instance id: | LA2_LAS_PPL/MOTOR/LINEAR_SPARE_3
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1H_NOPA_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1H_NOPA_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1H_NOPA_SPARE

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPARE
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1H_UNCOMP_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1H_UNCOMP_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1V_NOPA_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1V_NOPA_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1V_NOPA_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1V_UNCOMP_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT1V_UNCOMP_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2H_NOPA_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2H_NOPA_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2H_NOPA_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2H_UNCOMP_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2H_UNCOMP_SCS

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SCS
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2V_NOPA_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2V_NOPA_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2V_NOPA_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2V_UNCOMP_EXP

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MIRROUT2V_UNCOMP_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROT_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/ROT_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROT_SPARE_2

Instance id: | LA2_LAS_PPL/MOTOR/ROT_SPARE_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROT_SPARE_3

Instance id: | LA2_LAS_PPL/MOTOR/ROT_SPARE_3
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SPECTUNE_NOPA_EXP_1

Instance id: | LA2_LAS_PPL/MOTOR/SPECTUNE_NOPA_EXP_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | LA2_LAS_PPLMOTOR/SPECTUNE_NOPA, LA2_LAS_PPLMOTORSPECTUNE_NOPA
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_DIAG_EXP

Instance id: | LA2_LAS_PPL/MOTOR/WP_DIAG_EXP
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | EXPdmRFSignal
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_DIAG_SPARE

Instance id: | LA2_LAS_PPL/MOTOR/WP_DIAG_SPARE
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_EXP_1

Instance id: | LA2_LAS_PPL/MOTOR/WP_EXP_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | LA2_LAS_PPL-MOTOR-WP_EXP_1-simpleMotorScene, LA2_LAS_PPL/MOTOR/WP_EXP_1|simpleMotorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_EXP_2

Instance id: | LA2_LAS_PPL/MOTOR/WP_EXP_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_EXP_CR_1

Instance id: | LA2_LAS_PPL/MOTOR/WP_EXP_CR_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | LA2_LAS_PPL-MOTOR-WP_EXP_CR_1-simpleMotorScene, LA2_LAS_PPL/MOTOR/WP_EXP_CR_1|simpleMotorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_EXP_CR_2

Instance id: | LA2_LAS_PPL/MOTOR/WP_EXP_CR_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_EXP_CR_3

Instance id: | LA2_LAS_PPL/MOTOR/WP_EXP_CR_3
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_NOPA_EXP_1

Instance id: | LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_NOPA_EXP_2

Instance id: | LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_NOPA_EXP_3

Instance id: | LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_3
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_SPARE_1

Instance id: | LA2_LAS_PPL/MOTOR/WP_SPARE_1
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_SPARE_2

Instance id: | LA2_LAS_PPL/MOTOR/WP_SPARE_2
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_SPARE_3

Instance id: | LA2_LAS_PPL/MOTOR/WP_SPARE_3
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_SPARE_4

Instance id: | LA2_LAS_PPL/MOTOR/WP_SPARE_4
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_SPARE_5

Instance id: | LA2_LAS_PPL/MOTOR/WP_SPARE_5
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_SPARE_6

Instance id: | LA2_LAS_PPL/MOTOR/WP_SPARE_6
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_SPARE_7

Instance id: | LA2_LAS_PPL/MOTOR/WP_SPARE_7
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WP_TEM

Instance id: | LA2_LAS_PPL/MOTOR/WP_TEM
Class id: | BeckhoffSimpleMotor
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEM_XF1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### PMOTOR

###### CMCOMPSTAGE_RESET

Instance id: | LA2_LAS_PPL/PMOTOR/CMCOMPSTAGE_RESET
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DMCOMPSTAGE_RESET

Instance id: | LA2_LAS_PPL/PMOTOR/DMCOMPSTAGE_RESET
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | dmStageMotor
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### NANOSSPARE1_RESET

Instance id: | LA2_LAS_PPL/PMOTOR/NANOSSPARE1_RESET
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### NANOSSPARE2_RESET

Instance id: | LA2_LAS_PPL/PMOTOR/NANOSSPARE2_RESET
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TRACEYCOMP_EXP_2_RESET

Instance id: | LA2_LAS_PPL/PMOTOR/TRACEYCOMP_EXP_2_RESET
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TRACEYCOMP_EXP_RESET

Instance id: | LA2_LAS_PPL/PMOTOR/TRACEYCOMP_EXP_RESET
Class id: | BeckhoffDigitalOutput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.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

###### BEAMPIPES_ERROR

Instance id: | LA2_LAS_PPL/PUMP/BEAMPIPES_ERROR
Host: | exflcon144
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-12-18T15:47:36.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Giovanetti, Silenzi, Goeries
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf

###### BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

###### BEAMPIPES_ON

Instance id: | LA2_LAS_PPL/PUMP/BEAMPIPES_ON
Host: | exflcon144
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2019-12-18T15:47:36.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Giovanetti, Silenzi, Goeries
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: | LA2_LAS_PPL/VACUUM/CONTROL|default, LA2_LAS_PPL/VACUUM/CONTROL|default
Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf

##### SWITCH

###### CHILLER_COLLECTIVEALARM

Instance id: | LA2_LAS_PPL/SWITCH/CHILLER_COLLECTIVEALARM
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_FLOWALARM

Instance id: | LA2_LAS_PPL/SWITCH/CHILLER_FLOWALARM
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_GUIDEVALUEALARM

Instance id: | LA2_LAS_PPL/SWITCH/CHILLER_GUIDEVALUEALARM
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_PRESSUREALARM

Instance id: | LA2_LAS_PPL/SWITCH/CHILLER_PRESSUREALARM
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_TEMPERATUREALARM

Instance id: | LA2_LAS_PPL/SWITCH/CHILLER_TEMPERATUREALARM
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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

###### CHILLER_WATERALARM

Instance id: | LA2_LAS_PPL/SWITCH/CHILLER_WATERALARM
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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

###### TRIGGER

Instance id: | LA2_LAS_PPL/SWITCH/TRIGGER
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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

###### BEAMPIPES_ERROR

Instance id: | LA2_LAS_PPL/SWITCH/BEAMPIPES_ERROR
Class id: | BeckhoffDigitalInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

###### EQUIP_1

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_1
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EQUIP_2

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_2
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EQUIP_3

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_3
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EQUIP_4

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_4
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EQUIP_5

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_5
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EQUIP_6

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_6
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EQUIP_7

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_7
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EQUIP_8

Instance id: | LA2_LAS_PPL/TSENS/EQUIP_8
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_1

Instance id: | LA2_LAS_PPL/TSENS/TABLE_1
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Table_Temperatures
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_2

Instance id: | LA2_LAS_PPL/TSENS/TABLE_2
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_3

Instance id: | LA2_LAS_PPL/TSENS/TABLE_3
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Table_Temperatures
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_4

Instance id: | LA2_LAS_PPL/TSENS/TABLE_4
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Table_Temperatures
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_5

Instance id: | LA2_LAS_PPL/TSENS/TABLE_5
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Table_Temperatures
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_6

Instance id: | LA2_LAS_PPL/TSENS/TABLE_6
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_7

Instance id: | LA2_LAS_PPL/TSENS/TABLE_7
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TABLE_8

Instance id: | LA2_LAS_PPL/TSENS/TABLE_8
Class id: | BeckhoffAnalogInput
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VACUUM

###### CONTROL

PPL Vacuum Control

The `PplVacuumControl` device is documented in pplVacuumControl:welcome

##### VALVE

###### EXP

Instance id: | LA2_LAS_PPL/VALVE/EXP
Class id: | BeckhoffValve
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | LA2_LAS_PPL/VACUUM/CONTROL|default, VacuumMonitoring, LA2_LAS_PPL/VACUUM/CONTROL|default, LA2_LAS_PPL/VACUUM/CONTROL|default, LA2_LAS_PPL/VACUUM/CONTROL|default
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

###### PUMPLINE

Instance id: | LA2_LAS_PPL/VALVE/PUMPLINE
Class id: | BeckhoffValve
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SPARE

Instance id: | LA2_LAS_PPL/VALVE/SPARE
Class id: | BeckhoffValve
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SPARE_2

Instance id: | LA2_LAS_PPL/VALVE/SPARE_2
Class id: | BeckhoffValve
Host: | la2-rr-ppl-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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

##### MDL

###### BECKHOFF_MONITOR

Instance id: | LA2_LAS_PPL/MDL/BECKHOFF_MONITOR
Class id: | BeckhoffMonitor
Host: | la2-rr-ppl-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la2-rr-ppl-con-1
Git repo: | https://git.xfel.eu/karaboDevices/BeckhoffMonitor
Last modified: | 2021-06-02T11:48:16.000+02:00
Created at: | 2018-01-15T14:36:16.000+01:00
Main authors: | Fabbri, Kirienko, Silenzi
Latest tag: | 1.1.6-2.10.0
Deployment tag: | 1.1.6-2.10.0
Scenes: | LA2_LAS_PPL/MDL/BECKHOFF_MONITOR|Export PLC params
Accessible by: | CAL, CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Provides scenes for monitor
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Instantiate all devices on selected PLC
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- reset:
    Resets this Monitor device

Release History
1.1.6-2.10.0

Created: | 2021-05-20T19:08:59.000+02:00
Author: | Sergey Esenov
Notes: | Adapted to Python 3.8.x. No new features.

1.1.5-2.9.1

Created: | 2020-11-16T10:27:47.000+01:00
Author: | Riccardo Fabbri
Notes: | Update version info according to documentation https://in.xfel.eu/readthedocs/docs/karabo/en/latest/library/device_version.html

1.1.5-2.10.0

Created: | 2020-11-16T10:27:47.000+01:00
Author: | Riccardo Fabbri
Notes: | Indicate 2.10 compatibility

1.1.4-2.4.2

Created: | 2019-05-28T11:54:20.000+02:00
Author: | Yury Kirienko
Notes: | State handling enhanced

1.1.3-2.4.0

Created: | 2019-05-21T13:20:15.000+02:00
Author: | Riccardo Fabbri
Notes: |

1.1.2-2.4.0

Created: | 2019-05-09T18:43:42.000+02:00
Author: | Riccardo Fabbri
Notes: | Bug-fix to slotInstanceGone slot: redmine #32843 Scene to select PLC added (Yury) Reset slot added

1.1.1-2.4.0

Created: | 2019-04-30T14:17:25.000+02:00
Author: | Riccardo Fabbri
Notes: | Added variables to SD_MC2BECKHOFF

1.1.0-2.4.0

Created: | 2019-04-30T10:50:21.000+02:00
Author: | Riccardo Fabbri
Notes: | Bug-fix: State error handled: redmine #32841

1.0.9-2.4.0

Created: | 2019-03-11T16:27:14.000+01:00
Author: | Alessandro Silenzi
Notes: | Compatibility with new beckhoff methods to retrieve schema

1.0.8-2.2.6

Created: | 2018-11-06T17:39:58.000+01:00
Author: | Riccardo Fabbri
Notes: | PLC config saved in git repo

1.0.7-2.2.4

Created: | 2018-09-05T12:40:28.000+02:00
Author: | Riccardo Fabbri
Notes: | Optimized Saving of PLC device config

2.0.0a0

Created: | 2018-06-15T17:56:09.000+02:00
Author: | rfabbri
Notes: | working xml download

1.0.6-2.2.0

Created: | 2018-02-05T11:06:05.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.5-2.2.0

Created: | 2018-02-05T11:06:05.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.2.0

Created: | 2018-01-17T14:05:28.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.0

Created: | 2018-01-16T16:01:25.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.0

Created: | 2018-01-16T14:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.2.0

Created: | 2018-01-15T18:00:15.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.2.0

Created: | 2018-01-15T17:46:45.000+01:00
Author: | Dennis Goeries
Notes: |

###### CAM_WATCHDOG

###### STATE_WATCHDOG

Instance id: | LA2_LAS_PPL/MDL/STATE_WATCHDOG
Class id: | GenericActuator
Host: | la2-rr-ppl-con-1
Alias: | la2-rr-ppl-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: | CAM_ACQUIRING_WATCHDOG
Accessible by: | CONTROLS, CTRL, DA, WP78, brambrin, danilevc, kaned, pallasf, tjezynsk, 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)
- doaCXF1DIAGSTATE:
    The slot allows to run assigned action manually
- doaMPHOSFFSTATE:
    The slot allows to run assigned action manually
- doaMPHOSNFSTATE:
    The slot allows to run assigned action manually
- doaMPHOSINPUTNFSTATE:
    The slot allows to run assigned action manually
- dofEXF1FFSTATE:
    The slot allows to run assigned action manually
- dofEXF1NFSTATE:
    The slot allows to run assigned action manually
- dofEXF2NFSTATE:
    The slot allows to run assigned action manually
- donOPA1STATE:
    The slot allows to run assigned action manually
- donOPA2STATE:
    The slot allows to run assigned action manually
- donOPA3STATE:
    The slot allows to run assigned action manually
- donOPASEEDSTATE:
    The slot allows to run assigned action manually
- dotEMXF1FFSTATE:
    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

###### ARCHIVE_WATCHDOG

Instance id: | LA2_LAS_PPL/MDL/ARCHIVE_WATCHDOG
Class id: | GenericActuator
Host: | exflcon144
Alias: | la2-rr-ppl-con-1
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
- 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)
- dofixarchiving00:
    The slot allows to run assigned action manually
- dofixarchiving01:
    The slot allows to run assigned action manually
- dofixarchiving02:
    The slot allows to run assigned action manually
- dofixarchiving03:
    The slot allows to run assigned action manually
- dofixarchiving04:
    The slot allows to run assigned action manually
- dofixarchiving05:
    The slot allows to run assigned action manually

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)

###### MULTI_PATTERN

Instance id: | LA2_LAS_PPL/MDL/MULTI_PATTERN
Class id: | PplMultiSubPattern
Host: | exflcon146
Alias: | la1-br-ppl-con-pattern
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PplPattern
Last modified: | 2020-08-18T09:24:22.000+02:00
Created at: | 2018-08-06T14:02:03.000+02:00
Main authors: | Fabbri
Latest tag: | 1.5.5-2.9.1
Deployment tag: | 1.5.5-2.9.1
Scenes: | LA2_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA2_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

PPL multi sub pattern

The `PplMultiSubPattern` device is documented in pplPattern:welcome

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- doocsTimingServer:
    The name of Doocs timing server to contact
- doocsPatternServer:
    The name of Doocs server to contact for user-defined patterns
- pollingTime:
    Interval to wait before polling for an update from Doocs
- userName:
    The user name of the operator running the server/device
- userGroupName:
    The user-group in the system to be used when contacting the Doocs server to change the ppl pattern. In can happen that some users belong to different groups and they should choose one of them. This will provide the list of bits allowed to be modified by that user-group.
- userLaserBit:
    Selection of the ppl “User Laser” bit to use. Some users can be authorized to write on different bits of the “Bunch Pattern Table” in the Doocs server, according to which group they belong to. The smallest bit is chosen by defaulty, but they can select another one among the allowed ones.
- xfelTrainLength:
    The length of the xfel train
- xfelBunchCharge:
    The charge in the xfel bunches
- xfelBunchTiming:
    The bunch timing wrt to start of train.
- baseFrequency:
    Base frequency for the electron bunches.
- frequencyTable:
    Lookup table for values of the allowed pump-laser pulse frequency
- readFromDoocs:
    Read the current pattern configuration set in the Doocs server
- writeToDoocs:
    The patterns set by the user are written to the Doccs server
- writeSequenceToDoocs:
    The pattern sequence set by the user is written to the Doocs server. To apply it click on ‘Apply User Multi-Patterns’
- availableScenes:
    Scenes for the PplPattern
- isMultiPatternAllowed:
    This Boolean should be true in the Doocs server in order to use the user ppl patterns
- patternType:
    One of the eight possible (A to H) patterns configurable by the user. Select it to read its current status in DOOCS and/or to modify it.
- patternUserSequence:
    The pattern sequence (N[A] + M[B] …). Write Config to Doocs to set a new sequence
- patternDoocsSequence:
    The pattern sequence (N[A] + M[B] …). Read Config from Doocs to retrieve current sequence.
- userPplPattern:
    Locally selected pattern to fire PPL
- doocsPplPattern:
    Actual pattern to fire PPL running in Doocs
- pplTrainLength:
    The length of the complete burst (comprising laser pulses and empty bunches), from first to last pulse in a train.
- totBurstDuration:
    Duration of complete burst from first to last pulse in a train.
- subpattern_0:
    subpattern 0
- subpattern_1:
    subpattern 1
- subpattern_2:
    subpattern 2
- subpattern_3:
    subpattern 3

Release History
1.5.5-2.9.1

Created: | 2020-08-17T12:00:55.000Z
Author: | Riccardo Fabbri
Notes: | Aligned with timeserver change (output is now DAQ compatible).

1.5.4-2.9.1

Created: | 2020-08-17T11:01:20.000Z
Author: | Riccardo Fabbri
Notes: | Input Channel implemented.

1.5.3-2.9.1

Created: | 2020-07-24T16:32:20.000Z
Author: | Riccardo Fabbri
Notes: | PplOverview: Bug/Fix when comparing arrays in decode_bunch_pattern.

1.5.2-2.9.1

Created: | 2020-07-23T14:32:30.000Z
Author: | Riccardo Fabbri
Notes: | Implemented interval for pattern refresh.

1.5.1-2.9.1

Created: | 2020-06-30T11:44:20.000Z
Author: | Riccardo Fabbri
Notes: | Merge of similar functions.

1.5.0-2.9.1

Created: | 2020-06-30T10:10:56.000Z
Author: | Riccardo Fabbri
Notes: | Setter_periodic_pattern: with zero pulses we should have the pattern length to default 1 (one empty).

1.4.9-2.9.1

Created: | 2020-06-29T09:28:47.000Z
Author: | Riccardo Fabbri
Notes: | The update of key isOnPplGrid is independent from update of key isPeriodic.

1.4.8-2.9.1

Created: | 2020-06-11T08:41:52.000Z
Author: | Riccardo Fabbri
Notes: | Updated dependencies on doocsapi and euxfel_bunch_pattern.

1.4.7-2.7.1

Created: | 2020-04-03T14:55:23.000Z
Author: | Riccardo Fabbri
Notes: | Branch Feat/Refactoring merged to master

1.4.6-2.7.1

Created: | 2020-04-03T14:17:18.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Label changed and keys moved

1.4.5-2.7.1

Created: | 2020-04-03T09:05:29.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Obsolete intermediate steps removed for clarity

1.4.4-2.7.1

Created: | 2020-04-01T17:26:11.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Fix/remove not needed code in bases

1.4.3-2.7.1

Created: | 2020-04-01T13:58:54.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: DaqPolicy updated

1.4.2-2.7.1

Created: | 2020-04-01T09:30:46.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Align Unittest

1.4.1-2.7.1

Created: | 2020-03-31T13:00:38.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Align the key to set the ppl grid frequency with the actual pulse frequency in subpattern

1.4.0-2.7.1

Created: | 2020-03-31T10:14:55.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Optimizing code in _setter_periodic_pattern

1.3.9-2.7.1

Created: | 2020-03-30T08:27:16.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Remove redundant index column in lookup table

1.3.8-2.7.1

Created: | 2020-03-30T08:23:50.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: overview: Align scene with new totEmptyBunches key

1.3.7-2.7.1

Created: | 2020-03-30T07:24:56.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Distinguish empty types: inter-pulses only and all empties in a subpattern

1.3.6-2.7.1

Created: | 2020-03-27T15:25:23.000Z
Author: | Riccardo Fabbri
Notes: | Refactoring: Fix/pulse freq calculation

###### ADC_PEAKPOS_TEST

###### USER_STARTER

###### PATTERNS_OVERVIEW

###### PPL_INFOS_SASE2

##### PICKER

[add component documentation]

###### AMPHOS_FF

Instance id: | LA2_LAS_PPL/PICKER/AMPHOS_FF
Class id: | ImagePatternPicker
Host: | exflcon218
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imagePatternPicker
Last modified: | 2020-11-24T15:01:00.000+01:00
Created at: | 2019-04-18T15:10:53.000+02:00
Main authors: | Haufs, Parenti, Fabbri
Latest tag: | 1.0.3-2.10.0
Deployment tag: | 1.0.3-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Pattern Picker

The `ImagePatternPicker` device is documented in imagepatternpicker:image-pattern-picker-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.0.3-2.10.0

Created: | 2020-11-24T14:05:41.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.0.3-2.9.0

Created: | 2020-08-28T10:48:17.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix cross-hair pixel value range

1.0.2-2.8.3

Created: | 2020-05-20T13:49:16.000Z
Author: | Andrea Parenti
Notes: | Fix channel status setting

1.0.1-2.8.3

Created: | 2020-05-06T09:59:49.000Z
Author: | Andrea Parenti
Notes: | ADD Warning condition on trainId

1.0.0-2.8.0

Created: | 2020-03-19T08:00:56.000Z
Author: | Andrea Parenti
Notes: | FEAT Optionally apply a crosshair ADD Tests and CI configuration

0.7-2.7.1

Created: | 2020-02-19T09:50:39.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: Replacing timestamp in seconds with trainId.

0.6-2.6.1

Created: | 2019-10-18T14:39:55.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: DaqOutput channel gets its proper swapped dimensions

0.5-2.6.1

Created: | 2019-10-17T11:59:44.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: Output channels no more mixed

0.4-2.6.1

Created: | 2019-08-28T14:57:46.000Z
Author: | Riccardo Fabbri
Notes: | Indipendent channels added

0.3-2.4.2

Created: | 2019-06-26T08:15:49.000Z
Author: | Andrea Parenti
Notes: | Set output schema according to input Add DEPENDS file

0.2-2.4.1

Created: | 2019-05-22T13:20:38.000Z
Author: | Andrea Parenti
Notes: | Write trainId - as property - to output channel.

0.1-2.4.0

Created: | 2019-04-18T06:34:18.000Z
Author: | Andrea Parenti
Notes: |

###### AMPHOS_INPUT_NF

Instance id: | LA2_LAS_PPL/PICKER/AMPHOS_INPUT_NF
Class id: | ImagePatternPicker
Host: | exflcon218
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imagePatternPicker
Last modified: | 2020-11-24T15:01:00.000+01:00
Created at: | 2019-04-18T15:10:53.000+02:00
Main authors: | Haufs, Parenti, Fabbri
Latest tag: | 1.0.3-2.10.0
Deployment tag: | 1.0.3-2.10.0
Scenes: | TMP
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Pattern Picker

The `ImagePatternPicker` device is documented in imagepatternpicker:image-pattern-picker-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.0.3-2.10.0

Created: | 2020-11-24T14:05:41.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.0.3-2.9.0

Created: | 2020-08-28T10:48:17.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix cross-hair pixel value range

1.0.2-2.8.3

Created: | 2020-05-20T13:49:16.000Z
Author: | Andrea Parenti
Notes: | Fix channel status setting

1.0.1-2.8.3

Created: | 2020-05-06T09:59:49.000Z
Author: | Andrea Parenti
Notes: | ADD Warning condition on trainId

1.0.0-2.8.0

Created: | 2020-03-19T08:00:56.000Z
Author: | Andrea Parenti
Notes: | FEAT Optionally apply a crosshair ADD Tests and CI configuration

0.7-2.7.1

Created: | 2020-02-19T09:50:39.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: Replacing timestamp in seconds with trainId.

0.6-2.6.1

Created: | 2019-10-18T14:39:55.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: DaqOutput channel gets its proper swapped dimensions

0.5-2.6.1

Created: | 2019-10-17T11:59:44.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: Output channels no more mixed

0.4-2.6.1

Created: | 2019-08-28T14:57:46.000Z
Author: | Riccardo Fabbri
Notes: | Indipendent channels added

0.3-2.4.2

Created: | 2019-06-26T08:15:49.000Z
Author: | Andrea Parenti
Notes: | Set output schema according to input Add DEPENDS file

0.2-2.4.1

Created: | 2019-05-22T13:20:38.000Z
Author: | Andrea Parenti
Notes: | Write trainId - as property - to output channel.

0.1-2.4.0

Created: | 2019-04-18T06:34:18.000Z
Author: | Andrea Parenti
Notes: |

###### AMPHOS_NF

Instance id: | LA2_LAS_PPL/PICKER/AMPHOS_NF
Class id: | ImagePatternPicker
Host: | exflcon218
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imagePatternPicker
Last modified: | 2020-11-24T15:01:00.000+01:00
Created at: | 2019-04-18T15:10:53.000+02:00
Main authors: | Haufs, Parenti, Fabbri
Latest tag: | 1.0.3-2.10.0
Deployment tag: | 1.0.3-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Pattern Picker

The `ImagePatternPicker` device is documented in imagepatternpicker:image-pattern-picker-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.0.3-2.10.0

Created: | 2020-11-24T14:05:41.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.0.3-2.9.0

Created: | 2020-08-28T10:48:17.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix cross-hair pixel value range

1.0.2-2.8.3

Created: | 2020-05-20T13:49:16.000Z
Author: | Andrea Parenti
Notes: | Fix channel status setting

1.0.1-2.8.3

Created: | 2020-05-06T09:59:49.000Z
Author: | Andrea Parenti
Notes: | ADD Warning condition on trainId

1.0.0-2.8.0

Created: | 2020-03-19T08:00:56.000Z
Author: | Andrea Parenti
Notes: | FEAT Optionally apply a crosshair ADD Tests and CI configuration

0.7-2.7.1

Created: | 2020-02-19T09:50:39.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: Replacing timestamp in seconds with trainId.

0.6-2.6.1

Created: | 2019-10-18T14:39:55.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: DaqOutput channel gets its proper swapped dimensions

0.5-2.6.1

Created: | 2019-10-17T11:59:44.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: Output channels no more mixed

0.4-2.6.1

Created: | 2019-08-28T14:57:46.000Z
Author: | Riccardo Fabbri
Notes: | Indipendent channels added

0.3-2.4.2

Created: | 2019-06-26T08:15:49.000Z
Author: | Andrea Parenti
Notes: | Set output schema according to input Add DEPENDS file

0.2-2.4.1

Created: | 2019-05-22T13:20:38.000Z
Author: | Andrea Parenti
Notes: | Write trainId - as property - to output channel.

0.1-2.4.0

Created: | 2019-04-18T06:34:18.000Z
Author: | Andrea Parenti
Notes: |

###### FE_XF1_FF

Instance id: | LA2_LAS_PPL/PICKER/FE_XF1_FF
Class id: | ImagePatternPicker
Host: | exflcon218
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imagePatternPicker
Last modified: | 2020-11-24T15:01:00.000+01:00
Created at: | 2019-04-18T15:10:53.000+02:00
Main authors: | Haufs, Parenti, Fabbri
Latest tag: | 1.0.3-2.10.0
Deployment tag: | 1.0.3-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Pattern Picker

The `ImagePatternPicker` device is documented in imagepatternpicker:image-pattern-picker-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.0.3-2.10.0

Created: | 2020-11-24T14:05:41.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.0.3-2.9.0

Created: | 2020-08-28T10:48:17.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix cross-hair pixel value range

1.0.2-2.8.3

Created: | 2020-05-20T13:49:16.000Z
Author: | Andrea Parenti
Notes: | Fix channel status setting

1.0.1-2.8.3

Created: | 2020-05-06T09:59:49.000Z
Author: | Andrea Parenti
Notes: | ADD Warning condition on trainId

1.0.0-2.8.0

Created: | 2020-03-19T08:00:56.000Z
Author: | Andrea Parenti
Notes: | FEAT Optionally apply a crosshair ADD Tests and CI configuration

0.7-2.7.1

Created: | 2020-02-19T09:50:39.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: Replacing timestamp in seconds with trainId.

0.6-2.6.1

Created: | 2019-10-18T14:39:55.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: DaqOutput channel gets its proper swapped dimensions

0.5-2.6.1

Created: | 2019-10-17T11:59:44.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: Output channels no more mixed

0.4-2.6.1

Created: | 2019-08-28T14:57:46.000Z
Author: | Riccardo Fabbri
Notes: | Indipendent channels added

0.3-2.4.2

Created: | 2019-06-26T08:15:49.000Z
Author: | Andrea Parenti
Notes: | Set output schema according to input Add DEPENDS file

0.2-2.4.1

Created: | 2019-05-22T13:20:38.000Z
Author: | Andrea Parenti
Notes: | Write trainId - as property - to output channel.

0.1-2.4.0

Created: | 2019-04-18T06:34:18.000Z
Author: | Andrea Parenti
Notes: |

###### FE_XF1_NF

Instance id: | LA2_LAS_PPL/PICKER/FE_XF1_NF
Class id: | ImagePatternPicker
Host: | exflcon218
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imagePatternPicker
Last modified: | 2020-11-24T15:01:00.000+01:00
Created at: | 2019-04-18T15:10:53.000+02:00
Main authors: | Haufs, Parenti, Fabbri
Latest tag: | 1.0.3-2.10.0
Deployment tag: | 1.0.3-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Pattern Picker

The `ImagePatternPicker` device is documented in imagepatternpicker:image-pattern-picker-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.0.3-2.10.0

Created: | 2020-11-24T14:05:41.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.0.3-2.9.0

Created: | 2020-08-28T10:48:17.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix cross-hair pixel value range

1.0.2-2.8.3

Created: | 2020-05-20T13:49:16.000Z
Author: | Andrea Parenti
Notes: | Fix channel status setting

1.0.1-2.8.3

Created: | 2020-05-06T09:59:49.000Z
Author: | Andrea Parenti
Notes: | ADD Warning condition on trainId

1.0.0-2.8.0

Created: | 2020-03-19T08:00:56.000Z
Author: | Andrea Parenti
Notes: | FEAT Optionally apply a crosshair ADD Tests and CI configuration

0.7-2.7.1

Created: | 2020-02-19T09:50:39.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: Replacing timestamp in seconds with trainId.

0.6-2.6.1

Created: | 2019-10-18T14:39:55.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: DaqOutput channel gets its proper swapped dimensions

0.5-2.6.1

Created: | 2019-10-17T11:59:44.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: Output channels no more mixed

0.4-2.6.1

Created: | 2019-08-28T14:57:46.000Z
Author: | Riccardo Fabbri
Notes: | Indipendent channels added

0.3-2.4.2

Created: | 2019-06-26T08:15:49.000Z
Author: | Andrea Parenti
Notes: | Set output schema according to input Add DEPENDS file

0.2-2.4.1

Created: | 2019-05-22T13:20:38.000Z
Author: | Andrea Parenti
Notes: | Write trainId - as property - to output channel.

0.1-2.4.0

Created: | 2019-04-18T06:34:18.000Z
Author: | Andrea Parenti
Notes: |

###### FE_XF2_NF

Instance id: | LA2_LAS_PPL/PICKER/FE_XF2_NF
Class id: | ImagePatternPicker
Host: | exflcon218
Alias: | la2-rr-ppl-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imagePatternPicker
Last modified: | 2020-11-24T15:01:00.000+01:00
Created at: | 2019-04-18T15:10:53.000+02:00
Main authors: | Haufs, Parenti, Fabbri
Latest tag: | 1.0.3-2.10.0
Deployment tag: | 1.0.3-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Pattern Picker

The `ImagePatternPicker` device is documented in imagepatternpicker:image-pattern-picker-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.0.3-2.10.0

Created: | 2020-11-24T14:05:41.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.0.3-2.9.0

Created: | 2020-08-28T10:48:17.000Z
Author: | Andrea Parenti
Notes: | Summary: Fix cross-hair pixel value range

1.0.2-2.8.3

Created: | 2020-05-20T13:49:16.000Z
Author: | Andrea Parenti
Notes: | Fix channel status setting

1.0.1-2.8.3

Created: | 2020-05-06T09:59:49.000Z
Author: | Andrea Parenti
Notes: | ADD Warning condition on trainId

1.0.0-2.8.0

Created: | 2020-03-19T08:00:56.000Z
Author: | Andrea Parenti
Notes: | FEAT Optionally apply a crosshair ADD Tests and CI configuration

0.7-2.7.1

Created: | 2020-02-19T09:50:39.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: Replacing timestamp in seconds with trainId.

0.6-2.6.1

Created: | 2019-10-18T14:39:55.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: DaqOutput channel gets its proper swapped dimensions

0.5-2.6.1

Created: | 2019-10-17T11:59:44.000Z
Author: | Riccardo Fabbri
Notes: | Bug/Fix: Output channels no more mixed

0.4-2.6.1

Created: | 2019-08-28T14:57:46.000Z
Author: | Riccardo Fabbri
Notes: | Indipendent channels added

0.3-2.4.2

Created: | 2019-06-26T08:15:49.000Z
Author: | Andrea Parenti
Notes: | Set output schema according to input Add DEPENDS file

0.2-2.4.1

Created: | 2019-05-22T13:20:38.000Z
Author: | Andrea Parenti
Notes: | Write trainId - as property - to output channel.

0.1-2.4.0

Created: | 2019-04-18T06:34:18.000Z
Author: | Andrea Parenti
Notes: |

##### POE

[add component documentation]

###### 1030_CAM

###### AC_XF1_DIAG

###### AC_XF2_DIAG

###### AMPHOS_FF

###### AMPHOS_INPUT_NF

###### AMPHOS_NF

###### FE_XF1_FF

###### FE_XF1_NF

###### FE_XF2_NF

###### NOPA_1

###### NOPA_2

###### NOPA_3

###### NOPA_SEED

###### TELESCOPE_CAM

###### TEM_XF1_FF

###### BEAMPIPE

##### ADQ

[add component documentation]

###### 1

Instance id: | LA2_LAS_PPL/ADQ/1
Class id: | AdqDigitizer
Host: | la2-las-sys-utc-1
Class documentation:
| AdqDigitizer
Alias: | la2-las-sys-utc-1-mch
Git repo: | https://git.xfel.eu/karaboDevices/adqDigitizer
Last modified: | 2021-05-18T17:33:08.000+02:00
Created at: | 2017-05-09T17:54:27.000+02:00
Main authors: | Hauf, Fabbri, Haufs
Latest tag: | 4.4.4-2.10.0
Deployment tag: | 4.4.4-2.10.0
Installed tag: | 4.3.1-2.10.0
Scenes: | TMP, LA2LASPPL-GENERAL, LA2LASPPL-MAIN, LA2LASPPL-APD-1, TMP, ADQ14, ADQ14-NEW, ADC_ADQ14, ADQ14
Accessible by: | CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Might be hot-fixed, dt=6 days, 1:13:00!

Warning

The installed tag (4.3.1-2.10.0) does not match tags mentioned in the deployment ([‘4.4.4-2.10.0’])!

ADQ Digitizer

The `AdqDigitizer` device is documented in adqdigitizer:welcome

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts data acquisition.
- stop:
    Stops data acquisition.
- swtrigger:
    Sends a software trigger to the hardware (always possible, independent of chosen trigger mode).
- reset:
    Resets the device by reconnecting the hardware.
- adqapiRevision:
    SP DEVICES software revision
- trainIdSource:
    Select source of train ID
- acquireCount:
    Number of triggers to process in one run (0 denotes an infinite run, which needs to be stopped explicitely).
- acquisitionTime:
    Acquisition time. Closely connected to ‘acquireCount’ (Triggers per Run): 1 sec == 10 triggers. 0 means forever. This parameter has a precedency over acquireCount.
- lengthOfBufferPool:
    Length of the pool of output Hashes for sending to DAQ. Run will be stopped if we use all entries.
- boardsTimeShift:
    The time shift between two consecutive boards in milliseconds while sending raw data from FPGA
- sizeFilledBuffers:
    Size of filled buffers queue. Normal to be 0. Max value is buffer pool size
- dumpEnable:
    If enabled the binary stream data will be stored without parsing as is
- dumpfile:
    File name of dumped RAW data for selected Board/Channel. Extension ‘.bin’ means binary otherwise text format

Release History
4.4.4-2.10.0

Created: | 2021-05-11T12:48:09.000+02:00
Author: | Wajid Ehsan
Notes: | Avoid concurrent writes to the output channel

4.4.3-2.10.0

Created: | 2021-04-28T22:44:21.000+02:00
Author: | Sergey Esenov
Notes: | Fix board configurations

4.4.2-2.10.0

Created: | 2021-04-12T17:06:38.000+02:00
Author: | Wajid Ehsan
Notes: | Interim solution added to remind users that now cycling of DAQ is required to include schema related changes.

4.4.0-2.10.0

Created: | 2021-02-23T15:12:05.000+01:00
Author: | Wajid Ehsan
Notes: | Tag for ADQ412. Firmware 021-002-006-A or 021-002-006-B required. For potential support for ADQ7 and ADQ14.

4.3.1-2.10.0

Created: | 2020-11-30T10:43:54.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.12-2.10.0

Created: | 2020-11-24T17:33:21.000+01:00
Author: | Wajid Ehsan
Notes: | Tag to be used for old versions of the firmware which does not have the changing sample number issue

4.3.0-2.9.1-hotfix-2

Created: | 2020-09-07T14:05:12.000+02:00
Author: | Robert Schaffer
Notes: | Added “None” option for trigger output

4.3.0-2.9.1-hotfix

Created: | 2020-08-31T09:05:31.000+02:00
Author: | Robert Schaffer
Notes: | Removed zero suppression from the schema to eliminate issues with the DAQ

4.1.10-2.3.4-fix

Created: | 2020-08-12T16:10:52.000+02:00
Author: | Robert Schaffer
Notes: | Similar fix for older digitizer firmware version

4.1.11-2.3.4-fix

Created: | 2020-08-12T14:35:04.000+02:00
Author: | Robert Schaffer
Notes: | Tag to be used for old versions of the firmware which does not have the changing sample number issue

4.3.0-2.9.1

Created: | 2020-07-29T14:35:44.000+02:00
Author: | Sergey Esenov
Notes: | Support for ADQ7, ADQ14 and fixed bug in ADQ412. Firmware 021-002-006-A required.

4.1.10-2.10.0-fix

Created: | 2020-07-29T14:35:44.000+02:00
Author: | Sergey Esenov
Notes: |

4.2.1-2.8.0

Created: | 2020-05-07T16:14:35.000+02:00
Author: | Sergey Esenov
Notes: | Updates and fixes to allow specific PES setup: high frequecy trigger rate, trigger signal on front panel,…

4.2.0-2.7.0

Created: | 2020-02-21T17:20:57.000+01:00
Author: | Sergey Esenov
Notes: | Requires ADQ412-3G/4G firmware “021-002-006-A” and not backward compatible with older firmware versions. Experimental support for ADQ7. No support yet for ADQ14.

4.1.11-2.3.4

Created: | 2019-05-10T14:45:45.000+02:00
Author: | Sergey Esenov
Notes: | This version requires the firmware ‘021-002-005-C’. Check the used firmware with AE group.

4.1.10-2.3.4

Created: | 2019-04-01T18:51:21.000+02:00
Author: | Sergey Esenov
Notes: | Fix bug in initialization of NDArray in digitizer and use NDArrays by default.

4.1.9-2.3.4

Created: | 2019-03-21T11:30:39.000+01:00
Author: | Sergey Esenov
Notes: | Fix calculation of number of pulses, improve error reporting and actions when stopping the run

4.1.8-2.3.4

Created: | 2019-03-05T16:54:26.000+01:00
Author: | Sergey Esenov
Notes: | Bug fixing release: misinterpreted index, recovery trigger settings after the crash.

4.1.7-2.3.4

Created: | 2019-02-25T14:17:36.000+01:00
Author: | Sergey Esenov
Notes: | Fix race condition and SEGFAULT.

4.1.6-2.3.4

Created: | 2019-02-19T16:09:13.000+01:00
Author: | Sergey Esenov
Notes: | Attempt to fix SIGSEGV by avoid operations with invalid iterator. Introduce parameter that limits the time range where zero suppression and peak detection algorithms work.

### DAQ

#### DATA

##### DA

###### 1

Instance id: | LA2_DAQ_DATA/DA/1
Class id: | DataAggregator
Host: | la2-br-sys-daq-srv1
Alias: | la2-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: | LA2_RUN_CONTROL_1-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

##### DM

###### CONFIGURATOR_1

Instance id: | LA2_DAQ_DATA/DM/CONFIGURATOR_1
Class id: | RunConfigurator
Host: | la2-br-sys-daq-srv1
Alias: | la2-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
Scenes: | LA2_RUN_CONTROL_1-OBSOLETE, LA2_RUN_CONTROLLER_GLOBAL_STATE_OBSOLETE, LA2_RUN_CONTROLLER_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: | LA2_DAQ_DATA/DM/DATA_MANAGER_1
Class id: | DataManager
Host: | la2-br-sys-daq-srv1
Alias: | la2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Resets the device in case of an error
- operationMode:
    Operation mode
- metadataSchemaVersion:
    Metadata schema version
- instrumentsList:
    List of instruments for this DAQ instance (e.g FXE,SA1)!
- proposalNumber:
    Proposal number
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runNumber:
    Current run number
- user:
    User
- localConfiguration:
    Local configuration
- remoteConfiguration:
    Remote configuration
- debug:
    Debug mode

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### DSG_CHECK_1

Instance id: | LA2_DAQ_DATA/DM/DSG_CHECK_1
Class id: | CheckConfigGroups
Host: | la2-br-sys-daq-dsg1
Alias: | la2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/karaboDevices/checkConfigGroups
Last modified: | 2021-09-19T11:41:51.075+02:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Haufs, Tirumalai
Latest tag: | 2.2.2-2.5.0
Deployment tag: | 2.2.2-2.5.0
Scenes: | EMAIL_COFIGURATION_GROUPS, CHECK_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- availableGroups:
    Avialable groups
- scanGroupsResult:
    Scan Results
- configuratorId:
    DAQ CONFIGURATOR device Id
- timeServerId:
    A timeServerId to get a trainId
- recentTrainId:
    Most recently published train ID from timeServer
- trainIdThreshold:
    Threshold for trainId
- checkTrainIdFrom:
    Return TrainId from device slot/configuration

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### DSG_REPORT_1

Instance id: | LA2_DAQ_DATA/DM/DSG_REPORT_1
Class id: | ReportConfigGroups
Host: | la2-br-sys-daq-dsg1
Alias: | la2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/karaboDevices/checkConfigGroups
Last modified: | 2021-09-19T11:41:51.075+02:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Haufs, Tirumalai
Latest tag: | 2.2.2-2.5.0
Deployment tag: | 2.2.2-2.5.0
Scenes: | EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- diffResult:
    Diff Results
- topicId:
    Topic identifier used by this device
- filenameId:
    Name of the file generated and send by email
- emailToId:
    Email to where the report should be send

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### MDC_REMOTE_1

Instance id: | LA2_DAQ_DATA/DM/MDC_REMOTE_1
Class id: | MetadataDBRemote
Host: | la2-br-sys-daq-srv1
Alias: | la2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/metadataDBRemote
Last modified: | 2021-06-23T14:42:53.000+02:00
Created at: | 2017-03-02T16:11:47.000+01:00
Main authors: | Maia, Hauf
Latest tag: | 3.3.0-2.11.1
Deployment tag: | 3.3.0-2.11.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- client_email:
    Metadata Catalogue Client User email address
- client_id:
    Metadata Catalogue User Oauth identifier
- client_secret:
    Metadata Catalogue User Oauth secret
- metadata_application_url:
    Metadata Catalogue application Web Url

Release History
3.3.0-2.11.1

Created: | 2021-06-23T14:55:12.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.3.0-2.11.1

3.2.2-2.11.1

Created: | 2021-06-18T14:42:04.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.11.1

3.2.2-2.10.5

Created: | 2021-06-04T15:22:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.10.5

3.2.1-2.10.5.rc1

Created: | 2021-06-03T17:17:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.1-2.10.5.rc1

3.2.0-2.10.5

Created: | 2021-06-03T03:39:27.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.0-2.10.5

3.1.0-2.10.5

Created: | 2021-06-02T22:52:53.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.1.0-2.10.5

3.0.7-2.10.1-rx1

Created: | 2021-06-02T12:57:58.000+02:00
Author: | Nasser Al-Qudami
Notes: |

3.0.7-2.9.2

Created: | 2020-06-30T22:51:41.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.7-2.9.2

3.0.6-2.9.1_rc1

Created: | 2020-06-11T10:48:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.6-2.9.1_rc1

3.0.4-2.9.1

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.9.1

3.0.4-2.7.0

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.7.0

3.0.3-2.6.1

Created: | 2019-08-23T08:12:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.6.1

3.0.3-2.5.1

Created: | 2019-08-23T00:53:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.5.1

3.0.0-2.5.1

Created: | 2019-08-16T15:26:20.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.0-2.5.1

2.0.0-2.2.0

Created: | 2017-12-21T15:52:41.000+01:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.0

1.1.6-2.1.18

Created: | 2017-12-21T09:32:55.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.6-2.1.18

1.1.5-2.1.18

Created: | 2017-12-20T11:48:53.000+01:00
Author: | Luis Maia
Notes: | In this tag: * Release version 1.1.5-2.1.18 * Update MetadataClient to 1.1.4.1 * Comment issue that prevents device installation via Ansible

1.1.4-2.1.16

Created: | 2017-11-10T14:19:21.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.4-2.1.16

1.1.2-2.1.12

Created: | 2017-09-13T20:17:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.2-2.1.12

1.1.1-2.1.12

Created: | 2017-09-04T18:42:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.1-2.1.12

###### RUN_CONTROL_1

Instance id: | LA2_DAQ_DATA/DM/RUN_CONTROL_1
Class id: | RunController
Host: | la2-br-sys-daq-srv1
Alias: | la2-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: | LA2_RUN_CONTROL_1-OBSOLETE, LA2_RUN_CONTROLLER_GLOBAL_STATE_OBSOLETE, LA2_RUN_CONTROLLER_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: |

###### ADC_ACO_GROUP

Instance id: | LA2_DAQ_DATA/DM/ADC_ACO_GROUP
Class id: | RunConfigurationGroup
Host: | la2-br-sys-daq-dsg1
Alias: | la2-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: |

###### LA2_CAM_PICKERS_GROUP

Instance id: | LA2_DAQ_DATA/DM/LA2_CAM_PICKERS_GROUP
Class id: | RunConfigurationGroup
Host: | la2-br-sys-daq-dsg1
Alias: | la2-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: |

###### LA2_DIGITIZER_GROUP

Instance id: | LA2_DAQ_DATA/DM/LA2_DIGITIZER_GROUP
Class id: | RunConfigurationGroup
Host: | la2-br-sys-daq-dsg1
Alias: | la2-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: |

###### CAMS_GROUP

Instance id: | LA2_DAQ_DATA/DM/CAMS_GROUP
Class id: | RunConfigurationGroup
Host: | la2-br-sys-daq-dsg1
Alias: | la2-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: |

###### IMG_PROC_DATA_GROUP

Instance id: | LA2_DAQ_DATA/DM/IMG_PROC_DATA_GROUP
Class id: | RunConfigurationGroup
Host: | la2-br-sys-daq-dsg1
Alias: | la2-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: |

###### LA2_DOC_ADHOC_GROUP

Instance id: | LA2_DAQ_DATA/DM/LA2_DOC_ADHOC_GROUP
Class id: | RunConfigurationGroup
Host: | la2-br-sys-daq-dsg1
Alias: | la2-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: |

###### POD_TEST_GROUP

Instance id: | LA2_DAQ_DATA/DM/POD_TEST_GROUP
Class id: | RunConfigurationGroup
Host: | la2-br-sys-daq-dsg1
Alias: | la2-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: |

##### DOC

[add component documentation]

###### 1

Instance id: | LA2_DAQ_DATA/DOC/1
Class id: | DataAggregator
Host: | la2-br-sys-daq-srv1
Alias: | la2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    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: |

### CTRL

[add component documentation]

#### TOOLING

[add component documentation]

##### MDL

[add component documentation]

###### BECKHOFF_ASSISTANT

#### VERIFY

[add component documentation]

##### MDL

[add component documentation]

###### ARCHIVE

## Non-standard installations

Host could not be accessed

Affected classes:
| DataAggregator, RunConfigurator, DataManager, MetadataDBRemote, RunController
Affected devices:
| LA2_DAQ_DATA/DA/1, LA2_DAQ_DATA/DA/2, LA2_DAQ_DATA/DOC/1, LA2_DAQ_DATA/DM/CONFIGURATOR_1, LA2_DAQ_DATA/DM/DATA_MANAGER_1, LA2_DAQ_DATA/DM/MDC_REMOTE_1, LA2_DAQ_DATA/DM/RUN_CONTROL_1

Host could not be accessed

Affected classes:
| RunConfigurationGroup, CheckConfigGroups, ReportConfigGroups
Affected devices:
| LA2_DAQ_DATA/DM/ADC_ACO_GROUP, LA2_DAQ_DATA/DM/CAMS_GROUP, LA2_DAQ_DATA/DM/IMG_PROC_DATA_GROUP, LA2_DAQ_DATA/DM/LA2_CAM_PICKERS_GROUP, LA2_DAQ_DATA/DM/LA2_DIGITIZER_GROUP, LA2_DAQ_DATA/DM/LA2_DOC_ADHOC_GROUP, LA2_DAQ_DATA/DM/POD_TEST_GROUP, LA2_DAQ_DATA/DM/DSG_CHECK_1, LA2_DAQ_DATA/DM/DSG_REPORT_1
BeckhoffAnalogInput:
| affected devices: LA2_LAS_PPL/ACTRL/GUIDELASER_EXP_1_CTL_OUT, LA2_LAS_PPL/ACTRL/GUIDELASER_EXP_2_CTL_OUT, LA2_LAS_PPL/ACTRL/HYGROMETER_1_HUMIDITY, LA2_LAS_PPL/ACTRL/HYGROMETER_1_TEMPERATURE, LA2_LAS_PPL/ASENS/INPUT1, LA2_LAS_PPL/ASENS/INPUT2, LA2_LAS_PPL/ASENS/INPUT3, LA2_LAS_PPL/ASENS/INPUT4, LA2_LAS_PPL/GAUGE/BEAMPIPE_EXP_1, LA2_LAS_PPL/GAUGE/BEAMPIPE_EXP_2, LA2_LAS_PPL/TSENS/EQUIP_1, LA2_LAS_PPL/TSENS/EQUIP_2, LA2_LAS_PPL/TSENS/EQUIP_3, LA2_LAS_PPL/TSENS/EQUIP_4, LA2_LAS_PPL/TSENS/EQUIP_5, LA2_LAS_PPL/TSENS/EQUIP_6, LA2_LAS_PPL/TSENS/EQUIP_7, LA2_LAS_PPL/TSENS/EQUIP_8, LA2_LAS_PPL/TSENS/TABLE_1, LA2_LAS_PPL/TSENS/TABLE_2, LA2_LAS_PPL/TSENS/TABLE_3, LA2_LAS_PPL/TSENS/TABLE_4, LA2_LAS_PPL/TSENS/TABLE_5, LA2_LAS_PPL/TSENS/TABLE_6, LA2_LAS_PPL/TSENS/TABLE_7, LA2_LAS_PPL/TSENS/TABLE_8, LAS_PPL_SA2XT/ASENS/AI_1, LAS_PPL_SA2XT/ASENS/AI_2, LAS_PPL_SA2XT/ASENS/AI_3, LAS_PPL_SA2XT/ASENS/AI_4, LAS_PPL_SA2XT/ASENS/HYGROMETER_SPARE_SIG, LAS_PPL_SA2XT/ASENS/HYGROMETER_SPARE_TEMP installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffAnalogOutput:
| affected devices: LA2_LAS_PPL/ACTRL/OUTPUT_1, LA2_LAS_PPL/ACTRL/OUTPUT_2, LA2_LAS_PPL/ACTRL/OUTPUT_3, LA2_LAS_PPL/ACTRL/OUTPUT_4, LA2_LAS_PPL/ASENS/GUIDELASER_EXP_1_MOD_IN, LA2_LAS_PPL/ASENS/GUIDELASER_EXP_2_MOD_IN, LAS_PPL_SA2XT/ACTRL/AO_1, LAS_PPL_SA2XT/ACTRL/AO_2, LAS_PPL_SA2XT/ACTRL/AO_3, LAS_PPL_SA2XT/ACTRL/AO_4 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalOutput:
| affected devices: LA2_LAS_PPL/DCTRL/BEAMPIPES_ON, LA2_LAS_PPL/DCTRL/CHILLER_REMOTESTART, LA2_LAS_PPL/DCTRL/GUIDELASER_EXP_1_LD_REM, LA2_LAS_PPL/DCTRL/GUIDELASER_EXP_2_LD_REM, LA2_LAS_PPL/PMOTOR/CMCOMPSTAGE_RESET, LA2_LAS_PPL/PMOTOR/DMCOMPSTAGE_RESET, LA2_LAS_PPL/PMOTOR/NANOSSPARE1_RESET, LA2_LAS_PPL/PMOTOR/NANOSSPARE2_RESET, LA2_LAS_PPL/PMOTOR/TRACEYCOMP_EXP_2_RESET, LA2_LAS_PPL/PMOTOR/TRACEYCOMP_EXP_RESET, LAS_PPL_SA2XT/DCTRL/24V_OUTPUT_1, LAS_PPL_SA2XT/DCTRL/24V_OUTPUT_2, LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_1, LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffEncoder:
| affected devices: LA2_LAS_PPL/ENC/CMCOMPSTAGE, LA2_LAS_PPL/ENC/DMCOMPSTAGE, LA2_LAS_PPL/ENC/NANOSSPARE1, LA2_LAS_PPL/ENC/NANOSSPARE2, LA2_LAS_PPL/ENC/NANOSSPARE2_2, LA2_LAS_PPL/ENC/TRACEYCOMP_EXP, LA2_LAS_PPL/ENC/TRACEYCOMP_EXP_2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffMonitor:
| affected devices: LA2_LAS_PPL/MDL/BECKHOFF_MONITOR installed at: None installation not in a standard path
BeckhoffSimpleMotor:
| affected devices: LA2_LAS_PPL/MOTOR/CYLLENS_EXP_FA, LA2_LAS_PPL/MOTOR/CYLLENS_EXP_SA, LA2_LAS_PPL/MOTOR/CYL_LENS_STAGE_1, LA2_LAS_PPL/MOTOR/CYL_LENS_STAGE_2, LA2_LAS_PPL/MOTOR/LINEAR_SPARE_1, LA2_LAS_PPL/MOTOR/LINEAR_SPARE_2, LA2_LAS_PPL/MOTOR/LINEAR_SPARE_3, LA2_LAS_PPL/MOTOR/MIRROUT1H_NOPA_EXP, LA2_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPARE_, LA2_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_EXP, LA2_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPARE_1, LA2_LAS_PPL/MOTOR/MIRROUT1V_NOPA_EXP, LA2_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPARE_1, LA2_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_EXP, LA2_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPARE_1, LA2_LAS_PPL/MOTOR/MIRROUT2H_NOPA_EXP, LA2_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPARE_1, LA2_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_EXP, LA2_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SCS, LA2_LAS_PPL/MOTOR/MIRROUT2V_NOPA_EXP, LA2_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPARE_1, LA2_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_EXP, LA2_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPARE_1, LA2_LAS_PPL/MOTOR/ROT_SPARE_1, LA2_LAS_PPL/MOTOR/ROT_SPARE_2, LA2_LAS_PPL/MOTOR/ROT_SPARE_3, LA2_LAS_PPL/MOTOR/SPECTUNE_NOPA_EXP_1, LA2_LAS_PPL/MOTOR/WP_DIAG_EXP, LA2_LAS_PPL/MOTOR/WP_DIAG_SPARE, LA2_LAS_PPL/MOTOR/WP_EXP_1, LA2_LAS_PPL/MOTOR/WP_EXP_2, LA2_LAS_PPL/MOTOR/WP_EXP_CR_1, LA2_LAS_PPL/MOTOR/WP_EXP_CR_2, LA2_LAS_PPL/MOTOR/WP_EXP_CR_3, LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_1, LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_2, LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_3, LA2_LAS_PPL/MOTOR/WP_SPARE_1, LA2_LAS_PPL/MOTOR/WP_SPARE_2, LA2_LAS_PPL/MOTOR/WP_SPARE_3, LA2_LAS_PPL/MOTOR/WP_SPARE_4, LA2_LAS_PPL/MOTOR/WP_SPARE_5, LA2_LAS_PPL/MOTOR/WP_SPARE_6, LA2_LAS_PPL/MOTOR/WP_SPARE_7, LA2_LAS_PPL/MOTOR/WP_TEM, LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_1, LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_2, LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_3, LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_4 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffCom: | affected devices: LA2_LAS_PPL/PLC/COM installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffPlcMonitor:
| affected devices: LA2_LAS_PPL/PLC/COM_PLCMON installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffDigitalInput:
| affected devices: LA2_LAS_PPL/SWITCH/BEAMPIPES_ERROR, LA2_LAS_PPL/SWITCH/CHILLER_COLLECTIVEALARM, LA2_LAS_PPL/SWITCH/CHILLER_FLOWALARM, LA2_LAS_PPL/SWITCH/CHILLER_GUIDEVALUEALARM, LA2_LAS_PPL/SWITCH/CHILLER_PRESSUREALARM, LA2_LAS_PPL/SWITCH/CHILLER_TEMPERATUREALARM, LA2_LAS_PPL/SWITCH/CHILLER_WATERALARM, LA2_LAS_PPL/SWITCH/TRIGGER_, LAS_PPL_SA2XT/SWITCH/DI_1, LAS_PPL_SA2XT/SWITCH/DI_2, LAS_PPL_SA2XT/SWITCH/DI_3, LAS_PPL_SA2XT/SWITCH/DI_4 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffValve: | affected devices: LA2_LAS_PPL/VALVE/EXP, LA2_LAS_PPL/VALVE/PUMPLINE, LA2_LAS_PPL/VALVE/SPARE, LA2_LAS_PPL/VALVE/SPARE_2, LAS_PPL_SA2XT/VALVE/PUMPLINE, LAS_PPL_SA2XT/VALVE/SPARE installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
BeckhoffMC2Base:
| affected devices: LAS_PPL_SA2XT/MOTOR/SMARACTCMCOMPSTAGE, LAS_PPL_SA2XT/MOTOR/SMARACTDMCOMPSTAGE, LAS_PPL_SA2XT/MOTOR/SMARACTDRIFTSPARE1, LAS_PPL_SA2XT/MOTOR/SMARACTDRIFTSPARE2, LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMPSPARE1, LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMPSPARE2, LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMP_MID_1, LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMP_MID_2 installed at: /scratch/xctrl/karabo/plugins/libbeckhoff.so not the deployed tag: 4.6.5-2.11.1 not in [‘4.8.2-2.11.1rc1’]
AdqDigitizer: | affected devices: LA2_LAS_PPL/ADQ/1 installed at: /home/xctrl/karabo/plugins/libadqDigitizer.so might be hot-fixed, dt=6 days, 1:13:00 not the deployed tag: 4.3.1-2.10.0 not in [‘4.4.4-2.10.0’]

## Non-standard deployments

### la2-rr-ppl-con-1

- Rogue install for BeckhoffAnalogInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffAnalogOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalOutput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffEncoder: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffMonitor: 1.1.6-2.10.0 installed but not in deployment.
- Rogue install for BeckhoffSimpleMotor: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalInput: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffValve: 4.6.5-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffMC2Base: 4.6.5-2.11.1 installed but not in deployment.

### la2-las-sys-utc-1

- Rogue install for FastAdc: 2.8.6-2.11.1 installed but not in deployment.
- Rogue install for AdqDigitizer: 4.3.1-2.10.0 installed but not in deployment.
- Rogue install for TimeServer: 2.8.1-2.11.1 installed but not in deployment.

## Non-standard instance ids

- BSTAB_TEST/MDL/TEST
- KaraboGuiErrorLogger

## Problematic Interface Configs

## Non-reachable devices

These devices are not included in any project or scene

- LA2_DAQ_DATA/DM/ADC_ACO_GROUP
- LA2_DAQ_DATA/DM/CAMS_GROUP
- LA2_DAQ_DATA/DM/IMG_PROC_DATA_GROUP
- LA2_DAQ_DATA/DM/LA2_CAM_PICKERS_GROUP
- LA2_DAQ_DATA/DM/LA2_DIGITIZER_GROUP
- LA2_DAQ_DATA/DM/LA2_DOC_ADHOC_GROUP
- LA2_DAQ_DATA/DM/POD_TEST_GROUP
- LA2_DAQ_DATA/DM/DATA_MANAGER_1
- LA2_DAQ_DATA/DM/MDC_REMOTE_1
- LA2_DAQ_DATA/DOC/1
- LA2_LAS_PPL/ACTRL/GUIDELASER_EXP_1_CTL_OUT
- LA2_LAS_PPL/ACTRL/GUIDELASER_EXP_2_CTL_OUT
- LA2_LAS_PPL/ACTRL/OUTPUT_1
- LA2_LAS_PPL/ACTRL/OUTPUT_2
- LA2_LAS_PPL/ACTRL/OUTPUT_3
- LA2_LAS_PPL/ACTRL/OUTPUT_4
- LA2_LAS_PPL/ASENS/GUIDELASER_EXP_1_MOD_IN
- LA2_LAS_PPL/ASENS/GUIDELASER_EXP_2_MOD_IN
- LA2_LAS_PPL/ASENS/INPUT1
- LA2_LAS_PPL/ASENS/INPUT2
- LA2_LAS_PPL/ASENS/INPUT3
- LA2_LAS_PPL/ASENS/INPUT4
- LA2_LAS_PPL/DCTRL/CHILLER_REMOTESTART
- LA2_LAS_PPL/DCTRL/GUIDELASER_EXP_1_LD_REM
- LA2_LAS_PPL/DCTRL/GUIDELASER_EXP_2_LD_REM
- LA2_LAS_PPL/ENC/DMCOMPSTAGE
- LA2_LAS_PPL/ENC/NANOSSPARE1
- LA2_LAS_PPL/ENC/NANOSSPARE2
- LA2_LAS_PPL/ENC/NANOSSPARE2_2
- LA2_LAS_PPL/ENC/TRACEYCOMP_EXP
- LA2_LAS_PPL/ENC/TRACEYCOMP_EXP_2
- LA2_LAS_PPL/GAUGE/BEAMPIPE_EXP_2
- LA2_LAS_PPL/MOTOR/CYLLENS_EXP_FA
- LA2_LAS_PPL/MOTOR/CYLLENS_EXP_SA
- LA2_LAS_PPL/MOTOR/CYL_LENS_STAGE_1
- LA2_LAS_PPL/MOTOR/CYL_LENS_STAGE_2
- LA2_LAS_PPL/MOTOR/LINEAR_SPARE_1
- LA2_LAS_PPL/MOTOR/LINEAR_SPARE_2
- LA2_LAS_PPL/MOTOR/LINEAR_SPARE_3
- LA2_LAS_PPL/MOTOR/MIRROUT1H_NOPA_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPARE_
- LA2_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPARE_1
- LA2_LAS_PPL/MOTOR/MIRROUT1V_NOPA_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPARE_1
- LA2_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPARE_1
- LA2_LAS_PPL/MOTOR/MIRROUT2H_NOPA_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPARE_1
- LA2_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SCS
- LA2_LAS_PPL/MOTOR/MIRROUT2V_NOPA_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPARE_1
- LA2_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_EXP
- LA2_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPARE_1
- LA2_LAS_PPL/MOTOR/ROT_SPARE_1
- LA2_LAS_PPL/MOTOR/ROT_SPARE_2
- LA2_LAS_PPL/MOTOR/ROT_SPARE_3
- LA2_LAS_PPL/MOTOR/WP_DIAG_SPARE
- LA2_LAS_PPL/MOTOR/WP_EXP_2
- LA2_LAS_PPL/MOTOR/WP_EXP_CR_2
- LA2_LAS_PPL/MOTOR/WP_EXP_CR_3
- LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_1
- LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_2
- LA2_LAS_PPL/MOTOR/WP_NOPA_EXP_3
- LA2_LAS_PPL/MOTOR/WP_SPARE_1
- LA2_LAS_PPL/MOTOR/WP_SPARE_2
- LA2_LAS_PPL/MOTOR/WP_SPARE_3
- LA2_LAS_PPL/MOTOR/WP_SPARE_4
- LA2_LAS_PPL/MOTOR/WP_SPARE_5
- LA2_LAS_PPL/MOTOR/WP_SPARE_6
- LA2_LAS_PPL/MOTOR/WP_SPARE_7
- LA2_LAS_PPL/PLC/COM
- LA2_LAS_PPL/PLC/COM_PLCMON
- LA2_LAS_PPL/PMOTOR/CMCOMPSTAGE_RESET
- LA2_LAS_PPL/PMOTOR/NANOSSPARE1_RESET
- LA2_LAS_PPL/PMOTOR/NANOSSPARE2_RESET
- LA2_LAS_PPL/PMOTOR/TRACEYCOMP_EXP_2_RESET
- LA2_LAS_PPL/PMOTOR/TRACEYCOMP_EXP_RESET
- LA2_LAS_PPL/SWITCH/BEAMPIPES_ERROR
- LA2_LAS_PPL/SWITCH/CHILLER_COLLECTIVEALARM
- LA2_LAS_PPL/SWITCH/CHILLER_FLOWALARM
- LA2_LAS_PPL/SWITCH/CHILLER_GUIDEVALUEALARM
- LA2_LAS_PPL/SWITCH/CHILLER_PRESSUREALARM
- LA2_LAS_PPL/SWITCH/CHILLER_TEMPERATUREALARM
- LA2_LAS_PPL/SWITCH/CHILLER_WATERALARM
- LA2_LAS_PPL/SWITCH/TRIGGER_
- LA2_LAS_PPL/TSENS/EQUIP_1
- LA2_LAS_PPL/TSENS/EQUIP_2
- LA2_LAS_PPL/TSENS/EQUIP_3
- LA2_LAS_PPL/TSENS/EQUIP_4
- LA2_LAS_PPL/TSENS/EQUIP_5
- LA2_LAS_PPL/TSENS/EQUIP_6
- LA2_LAS_PPL/TSENS/EQUIP_7
- LA2_LAS_PPL/TSENS/EQUIP_8
- LA2_LAS_PPL/TSENS/TABLE_2
- LA2_LAS_PPL/TSENS/TABLE_6
- LA2_LAS_PPL/TSENS/TABLE_7
- LA2_LAS_PPL/TSENS/TABLE_8
- LA2_LAS_PPL/VALVE/PUMPLINE
- LA2_LAS_PPL/VALVE/SPARE
- LA2_LAS_PPL/VALVE/SPARE_2
- LAS_PPL_SA2XT/ACTRL/AO_1
- LAS_PPL_SA2XT/ACTRL/AO_2
- LAS_PPL_SA2XT/ACTRL/AO_3
- LAS_PPL_SA2XT/ACTRL/AO_4
- LAS_PPL_SA2XT/ASENS/AI_1
- LAS_PPL_SA2XT/ASENS/AI_2
- LAS_PPL_SA2XT/ASENS/AI_3
- LAS_PPL_SA2XT/ASENS/AI_4
- LAS_PPL_SA2XT/ASENS/HYGROMETER_SPARE_SIG
- LAS_PPL_SA2XT/ASENS/HYGROMETER_SPARE_TEMP
- LAS_PPL_SA2XT/DCTRL/24V_OUTPUT_1
- LAS_PPL_SA2XT/DCTRL/24V_OUTPUT_2
- LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_1
- LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_2
- LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_3
- LAS_PPL_SA2XT/MOTOR/LINSTAGE_SPARE_4
- LAS_PPL_SA2XT/MOTOR/SMARACTDRIFTSPARE1
- LAS_PPL_SA2XT/MOTOR/SMARACTDRIFTSPARE2
- LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMPSPARE1
- LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMPSPARE2
- LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMP_MID_1
- LAS_PPL_SA2XT/MOTOR/SMARACTTRACYCOMP_MID_2
- LAS_PPL_SA2XT/SWITCH/DI_1
- LAS_PPL_SA2XT/SWITCH/DI_2
- LAS_PPL_SA2XT/SWITCH/DI_3
- LAS_PPL_SA2XT/SWITCH/DI_4
- LAS_PPL_SA2XT/VALVE/PUMPLINE
- LAS_PPL_SA2XT/VALVE/SPARE

## Access Rights Summary

CAL: | la2-rr-ppl-con-1
CONTROLS: | la2-las-sys-utc-1, la2-rr-ppl-con-1
CTRL: | la2-las-sys-utc-1, la2-rr-ppl-con-1
DA: | la2-rr-ppl-con-1
WP78: | la2-rr-ppl-con-1
brambrin: | la2-rr-ppl-con-1
danilevc: | la2-rr-ppl-con-1
kaned: | la2-las-sys-utc-1, la2-rr-ppl-con-1
pallasf: | la2-rr-ppl-con-1
xdoc: | la2-las-sys-utc-1, la2-rr-ppl-con-1
babies: | la2-las-sys-utc-1
cascella: | la2-las-sys-utc-1
mramilli: | la2-las-sys-utc-1
samartse: | la2-las-sys-utc-1
tjezynsk: | la2-las-sys-utc-1

## Scenes with outdated properties

The following scenes my contain properties not available anymore, or only available as part of a macro, which is not guaranteed to alway run.

### Scenes

#### CAM/FE_XF1_NF

projects: | Temporary2

- LA2_LAS_PPL/CAM/FE_XF1_NF.connectCamera

#### FE-details

projects: | FE-CTRL

- LA2_LAS_PPL/PROC/GALVO_DIAG.y0
- LA2_LAS_PPL/PROC/SEEDER_FE_SPARE.y0

#### LA2_LAS_PPL/CTRL/AC_XF1_DIAG|scene

projects: | LA2_NOPA

- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.ePulseWidth
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.delayUnit
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.useAsCalibrationImage1
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.status
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.xMinFit
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.calibrationFactor
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.delay
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.beamShape
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.state
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.xMaxFit
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.calibrate
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.useAsCalibrationImage2
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.fitStatus
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.subtractPedestal
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.output.schema.data.profileX,LA2_LAS_PPL/CTRL/AC_XF1_DIAG.output.schema.data.profileXFit
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.output.schema.data.integralX,LA2_LAS_PPL/CTRL/AC_XF1_DIAG.output.schema.data.integralXFit
- LA2_LAS_PPL/CTRL/AC_XF1_DIAG.pulseWidth

#### CAM/AMPHOS_INPUT_NF

projects: | Temporary2

- LA2_LAS_PPL/CAM/AMPHOS_INPUT_NF.connectCamera

#### TEM_XF1

projects: | LA2_TEM

- LA2_LAS_PPL/CTRL/TEM.connect

#### LA2_LAS_PPL/VACUUM/CONTROL|default

projects: | LA2_LAS_VACUUM

- LA2_LAS_PPL/GAUGE/BEAMPIPE.state
- LA2_LAS_PPL/PUMP/BEAMPIPES_ON.state
- LA2_LAS_PPL/GAUGE/BEAMPIPE.epsilon

#### Amphos-control-and-parameters

projects: | Temporary2

- LA2_LAS_PPL/ASENS/EMETER_AMPHOS_DIAG.measurement.pulse

#### TMP

projects: | LA2_DIAG

- Macro-R1-7b347018-9655-4549-9cb7-029d081561b2-Test.display
- test_ped_subtration.subtractPedestal
- LA2_LAS_PPL/CAM/FE_XF1_NF.bin.Y
- LA2_LAS_PPL/CAM/FE_XF1_NF.bin.X

#### exp_tune

projects: | LA2_DIAG

- Macro-adc_proc-9860adfb-705d-423f-aa6c-9351de99e429-AdcProc.PD_XF1,Macro-adc_proc-9860adfb-705d-423f-aa6c-9351de99e429-AdcProc.PD_NOPA1,Macro-adc_proc-9860adfb-705d-423f-aa6c-9351de99e429-AdcProc.PD_1030,Macro-adc_proc-9860adfb-705d-423f-aa6c-9351de99e429-AdcProc.PD_XF2

#### LA2_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern

projects: | LA2_PPL_PATTERN

- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.userPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.isMultiPatternAllowed
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternDoocsSequence
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternUserSequence
- LA2_LAS_PPL/MDL/MULTI_PATTERN.userName
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.doocsPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.writeSequenceToDoocs
- LA2_LAS_PPL/MDL/MULTI_PATTERN.userLaserBit
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternRepFactor
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternType
- LA2_LAS_PPL/MDL/MULTI_PATTERN.baseFrequency
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.userPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.doocsPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.userPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.doocsPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.userGroupName
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.userPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.writeToDoocs
- LA2_LAS_PPL/MDL/MULTI_PATTERN.readFromDoocs
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.doocsPplSubPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.xfelBunchCharge,LA2_LAS_PPL/MDL/MULTI_PATTERN.doocsPplPattern,LA2_LAS_PPL/MDL/MULTI_PATTERN.userPplPattern

#### TEM_XF2

projects: | LA2_TEM

- LA2_LAS_PPL/CTRL/TEM._connect_

#### AC_XF2_DIAG

projects: | Temporary2

- LA2_LAS_PPL/CAM/AC_XF2_DIAG.frameRateOut

#### CAM_ACQUIRING_WATCHDOG

projects: | LA2_LAS_WATCHDOGS

- LA2_LAS_PPL/MDL/STATE_WATCHDOG.actionsTable

#### LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW|View All Patterns

projects: | LA2_PPL_PATTERN

- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_FXE.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_FXE.pplPattern
- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SASE2.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SASE2.pplPattern
- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS2.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS2.pplPattern
- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS1.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS1.pplPattern
- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SCS.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SCS.pplPattern
- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_15.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_15.pplPattern
- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SPB.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SPB.pplPattern
- LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SQS.bunchCharge,LA2_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SQS.pplPattern

#### NOPA-3rd-stage

projects: | LA2_NOPA

- LA2_LAS_PPL/PROC/NOPA_3.x0,LA2_LAS_PPL/PROC/NOPA_3.y0
- LA2_LAS_PPL/ASENS/EMETER_NOPA_3.measurement.pulse
- LA2_LAS_PPL/ASENS/EMETER_NOPA_3.start
- LA2_LAS_PPL/SPECT/NOPA_3.wavelengths,LA2_LAS_PPL/SPECT/NOPA_3.output.schema.data.spectrum,LA2_LAS_PPL/SPECT/NOPA_3.refSpectrum
- LA2_LAS_PPL/ASENS/EMETER_NOPA_3.stop

#### CHECK_COFIGURATION_GROUPS

projects: | LA2_CHECK_CONFIG_GROUPS

- LA1_DAQ_DATA/DM/DSG_CHECK_1.availableGroups
- LA1_DAQ_DATA/DM/DSG_CHECK_1.deselectAllGroups
- LA1_DAQ_DATA/DM/DSG_CHECK_1.selectAllGroups
- LA1_DAQ_DATA/DM/DSG_CHECK_1.start
- LA1_DAQ_DATA/DM/DSG_CHECK_1.recentTrainId
- LA1_DAQ_DATA/DM/DSG_CHECK_1.checkConfigruationGroup
- LA1_DAQ_DATA/DM/DSG_CHECK_1.state
- LA1_DAQ_DATA/DM/DSG_CHECK_1.scanGroupsResult
- LA1_DAQ_DATA/DM/DSG_CHECK_1.statusMessage

#### CAM/AMPHOS_FF

projects: | Temporary2

- LA2_LAS_PPL/CAM/AMPHOS_NF.connectCamera

#### LA2_LAS_PPL/MDL/CAM_WATCHDOG|default_scene

projects: | LA2_LAS_WATCHDOGS

- LA2_LAS_PPL/MDL/CAM_WATCHDOG.cameras
- LA2_LAS_PPL/MDL/CAM_WATCHDOG.status
- LA2_LAS_PPL/MDL/CAM_WATCHDOG.maxAttempts
- LA2_LAS_PPL/MDL/CAM_WATCHDOG.timeout
- LA2_LAS_PPL/MDL/CAM_WATCHDOG.state
- LA2_LAS_PPL/MDL/CAM_WATCHDOG.deviceId
- LA2_LAS_PPL/MDL/CAM_WATCHDOG.reset

#### LA2_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern

projects: | LA2_PPL_PATTERN

- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.totEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.isMultiPatternAllowed
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pulseInterval
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternDoocsSequence
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternUserSequence
- LA2_LAS_PPL/MDL/MULTI_PATTERN.userName
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pplTrainDuration
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pulseInterval
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.numberOfLaserPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.numberOfEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.writeSequenceToDoocs
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.gridFrequencyMode
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pulseFrequency
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pplTrainDuration
- LA2_LAS_PPL/MDL/MULTI_PATTERN.userLaserBit
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pulseInterval
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.numberOfEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.numberOfEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternRepFactor
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pplTrainLength
- LA2_LAS_PPL/MDL/MULTI_PATTERN.patternType
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.numberOfEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.baseFrequency
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pplTrainLength
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.gridFrequencyMode
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.gridFrequencyMode
- LA2_LAS_PPL/MDL/MULTI_PATTERN.status
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pplTrainDuration
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.totEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pulseInterval
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.numberOfLaserPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pulseFrequency
- LA2_LAS_PPL/MDL/MULTI_PATTERN.userGroupName
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.totEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.totEmptyPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.isOnPplGrid
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pulseFrequency
- LA2_LAS_PPL/MDL/MULTI_PATTERN.frequencyTable
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.numberOfLaserPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.totBurstDuration
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.numberOfLaserPulses
- LA2_LAS_PPL/MDL/MULTI_PATTERN.writeToDoocs
- LA2_LAS_PPL/MDL/MULTI_PATTERN.readFromDoocs
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pplTrainLength
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pplTrainDuration
- LA2_LAS_PPL/MDL/MULTI_PATTERN.xfelBunchCharge,LA2_LAS_PPL/MDL/MULTI_PATTERN.doocsPplPattern,LA2_LAS_PPL/MDL/MULTI_PATTERN.userPplPattern
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pulseFrequency
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pplTrainLength
- LA2_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.gridFrequencyMode

#### Spectrum

projects: | LA2_SEEDER

- LA3_LAS_PPL/SPECPROC/SEEDER_SPECTROMETER.fitMaxWavelength
- LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.stop
- LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.wavelengths,LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.refSpectrum
- LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.acquire
- LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.triggerMode
- LA3_LAS_PPL/SPECPROC/SEEDER_SPECTROMETER.spectrumIntegral
- LA3_LAS_PPL/SPECPROC/SEEDER_SPECTROMETER.fWHMWavelength
- LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.useCurrentBkgSpectrum
- LA2_LAS_PPL/SPECT/SEEDER_SPECTROMETER.wavelengths,LA2_LAS_PPL/SPECT/SEEDER_SPECTROMETER.output.schema.data.spectrum,LA2_LAS_PPL/SPECT/SEEDER_SPECTROMETER.refSpectrum
- LA3_LAS_PPL/SPECPROC/SEEDER_SPECTROMETER.fitAmpl
- LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.integrationTime

#### Laser-status-scene

projects: | Instrument_Timing_and_Status

- LA2_LAS_PPL/PROC/NOPA_3.x0,LA2_LAS_PPL/PROC/NOPA_3.y0
- Macro-LP_read-10c6185b-9505-4f9a-8ca9-dc885c0ffb8d-LpRead.alive
- Macro-LP_read-10c6185b-9505-4f9a-8ca9-dc885c0ffb8d-LpRead.LP_SASE2p
- LA2_LAS_PPL/SPECT/NOPA_2.wavelengths,LA2_LAS_PPL/SPECT/NOPA_2.output.schema.data.spectrum,LA2_LAS_PPL/SPECT/NOPA_2.refSpectrum

#### 1030-Status-Scene

projects: | Instrument_Timing_and_Status

- LA2_LAS_PPL/PROC/1030_CAM.beamHeight1d,LA2_LAS_PPL/PROC/1030_CAM.beamWidth1d
- LA2_LAS_PPL/PROC/1030_CAM.x01d,LA2_LAS_PPL/PROC/1030_CAM.y01d

#### Timing-changes-800nm

projects: | Instrument_Timing_and_Status

- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.LOCK
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Ref_RF_HARMONIC
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_status
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.LSU_ODL_lock_position_steps
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.AOM_OFF
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_En
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SynchMode
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.FB_Reference
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_Timing_shifter_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Save
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Ref_OXC
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.RF_harmonic_phase_fs
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Restore
- Macro-LP_read-10c6185b-9505-4f9a-8ca9-dc885c0ffb8d-LpRead.train_id
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.lSet
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Timing_shifter_offset_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Clear
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Timestamp
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_Dis
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Status
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.switching_status
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.AOM_ON
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_LSU_ODL_lock_position_steps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Save_Restore_Status
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.def_state
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_Timing_shifter_offset_ps
- Macro-LP_read-10c6185b-9505-4f9a-8ca9-dc885c0ffb8d-LpRead.LP_SASE2p
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_State
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_En
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_OXC_ODL_position_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_signal_fs
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Stop
- Macro-LP_read-10c6185b-9505-4f9a-8ca9-dc885c0ffb8d-LpRead.alive
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Timing_shifter_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.ODL_status
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_ODL_position_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Dis
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Re_Lock_Status

#### lp_test

projects: | LA2_DIAG

- Macro-lp_test-18f708c0-2747-49a5-abfd-8890a62f71f0-LpTest.Stop
- Macro-lp_test-18f708c0-2747-49a5-abfd-8890a62f71f0-LpTest.TLP_Data
- Macro-lp_test-18f708c0-2747-49a5-abfd-8890a62f71f0-LpTest.Start
- Macro-lp_test-18f708c0-2747-49a5-abfd-8890a62f71f0-LpTest.l_LP
- Macro-lp_test-18f708c0-2747-49a5-abfd-8890a62f71f0-LpTest.Clear

#### LA2_LAS_PPL-CTRL-AC_XF2_DIAG-scene

projects: | LA2_XF2_Diagnostics

- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.calibrationFactor
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.useAsCalibrationImage2
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.pulseWidth
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.calibrate
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.output.schema.data.integralX,LA2_LAS_PPL/CTRL/AC_XF2_DIAG.output.schema.data.integralXFit
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.fitStatus
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.delay
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.ePulseWidth
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.status
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.state
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.delayUnit
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.subtractPedestal
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.beamShape
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.useAsCalibrationImage1
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.xMaxFit
- LA2_LAS_PPL/CTRL/AC_XF2_DIAG.xMinFit

#### CAM/FE_XF1_FF

projects: | Temporary2

- LA2_LAS_PPL/CAM/FE_XF1_FF.connectCamera

#### BOBCAT

projects: | LA2_DIAG

- LA2_LAS_PPL/CAM/BOBCAT.output.schema.data.image

#### framerates_new

projects: | TEST_BASLER

- LA2_LAS_PPL/CAM/AMPHOS_INPUT_NF_TEST.frameRate
- LA2_LAS_PPL/CAM/FE_XF1_FF_TEST.frameRate
- LA2_LAS_PPL/CAM/AMPHOS_FF_TEST.frameRate
- LA2_LAS_PPL/CAM/FE_XF1_NF_TEST.frameRate
- LA2_LAS_PPL/CAM/AC_XF1_DIAG_TEST.frameRate
- LA2_LAS_PPL/CAM/AC_XF2_DIAG_TEST.frameRate
- LA2_LAS_PPL/CAM/AMPHOS_NF_TEST.frameRate

#### test_ped_subtration|scene

projects: | LA2_DIAG

- test_ped_subtration.subtractPedestal
- test_ped_subtration.beamShape
- test_ped_subtration.pulseWidth
- test_ped_subtration.delay
- test_ped_subtration.useAsCalibrationImage2
- test_ped_subtration.delayUnit
- test_ped_subtration.ePulseWidth
- test_ped_subtration.xMinFit
- test_ped_subtration.state
- test_ped_subtration.useAsCalibrationImage1
- test_ped_subtration.fitStatus
- test_ped_subtration.xMaxFit
- test_ped_subtration.calibrationFactor
- test_ped_subtration.status
- test_ped_subtration.output.schema.data.profileX,test_ped_subtration.output.schema.data.profileXFit
- test_ped_subtration.calibrate

#### NOPA-1st-stage

projects: | LA2_NOPA

- LA2_LAS_PPL/PROC/NOPA_1.x0,LA2_LAS_PPL/PROC/NOPA_1.y0
- LA2_LAS_PPL/SPECT/NOPA_1.wavelengths,LA2_LAS_PPL/SPECT/NOPA_1.output.schema.data.spectrum,LA2_LAS_PPL/SPECT/NOPA_1.refSpectrum

#### NOPA-2nd-stage

projects: | LA2_NOPA

- LA2_LAS_PPL/SPECT/NOPA_2.wavelengths,LA2_LAS_PPL/SPECT/NOPA_2.output.schema.data.spectrum,LA2_LAS_PPL/SPECT/NOPA_2.refSpectrum
- LA2_LAS_PPL/PROC/NOPA_2.x0,LA2_LAS_PPL/PROC/NOPA_2.y0

#### find_AOM_Delay

projects: | LA2_TIMING

- Macro-find_AOM_delay-807dfee4-54b1-4288-9d5e-77ed45c1dcbe-FindAOMDelay.outData

#### Laser-status-scene_HED

projects: | Instrument_Timing_and_Status

- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.LOCK
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.UNLOCK
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_Dis
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_En
- LA2_LAS_PPL/ASENS/EMETER_NOPA_3.measurement.pulse
- LA2_LAS_PPL/SPECT/NOPA_3.wavelengths,LA2_LAS_PPL/SPECT/NOPA_3.output.schema.data.spectrum

#### ADQ14

projects: | LA2_DIAG

- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.p_1000
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.writeDelay_t
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.n_10
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.readReg
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.n_1
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.newDelay
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.writeDelay
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_1
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.newDelay_t
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.sRegDelay
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.INIT
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.p_10
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_100
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.p_10000
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.n_50ms
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.sRegDelayCnt
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_1000
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.p_100
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.lUnits
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.newDelay
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_50ms
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.n_10000
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.writeDelay
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.dev_status
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_10000
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_10000
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_50ms
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.writeDelay_t
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.lUnits
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_10
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_1000
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.sRegDelayCnt
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.sRegDelay
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.readReg
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.dev_status
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_1
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.p_50ms
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.INIT
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.p_10
- Macro-aqd_trg-2ce2e3bd-5ff7-4c8e-9c43-323066126082-AqdTrg.n_100
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.newDelay_t
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.n_1000
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.n_100
- Macro-adq_trg-32c5bfc0-49be-4af8-8189-d401deba5239-AqdTrg.p_1

#### LA2_LAS_PPL/MDL/USER_STARTER|generate_scene

projects: | LA2_LAS_USERSTARTER

- LA2_LAS_PPL/MDL/USER_STARTER.startMissing

#### PC-and-AOM-settings

projects: | LA2_TIMING

- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.AOM_OFF
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.AOM_ON
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.Applay_m_Burst_Width
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.def_state
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.Pockels_Cell_On
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.mBurstWidth
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.Pockels_Cell_Off

#### WorkInHutch

projects: | LA2_DIAG

- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.user_error
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.user_phone
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.user_name
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.WorkStart
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.workEn
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.def_state
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.WorkEnd
- Macro-work_in_hutch-e75a5acf-467b-4094-a83c-efdde64ecd4c-WorkInHutch.work_start

#### MOT_BEAM_TEST

projects: | LA2_MIRRORS_CTRL

- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.listMotor
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Status
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Calibrate
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.targetPosition
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Down
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.selectMotor
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Stop
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Move
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Off
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.ResetAllErrors
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.ResetAllErrors
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Stop
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.selectMotor
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Calibrate
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Home
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.listMotor
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Off
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.GetTraget
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.all_ON
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Down
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.On
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.CalibrateAll
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.GetTraget
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Status
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.WriteParams
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.actualPosition
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.motorId
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.motorId
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Home
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.all_OFF
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Move
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.On
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.targetPosition
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.actualPosition
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Up
- Macro-mot_beam_prop-55aca3a8-2afc-4d62-a59f-ff2f1c398ca4-MotBeamProp.Up

#### EXP_NOPA_BEAM_POS_ALL

projects: | Instrument_Timing_and_Status

- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2V_Status
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_H_Down
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2h_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_V_Down
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_H_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorH_limit
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_motorH_pos
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2H_Status
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_motorH_limit
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2v_p100
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_V_Up
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_H_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_V_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1H_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_V_Down
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2h_p10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorH_pos
- SCS_ILH_LAS/CAM/8CAM1.output.schema.data.image
- SCS_ILH_LAS/PROC/8CAM1.x0,SCS_ILH_LAS/PROC/8CAM1.y0
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.all_OFF
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_motorV_pos
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.all_ON
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1v_p10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_motorH_pos
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorV_pos
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorV_pos
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_H_Up
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.all_ON
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2H_Status
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_V_Down
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1h_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_V_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_n100
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2h_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.exp
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_H_Down
- SCS_ILH_LAS/CAM/8CAM1.deviceId
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1v_n10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2v_p10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1h_p100
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_motorV_limit
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorV_limit
- SCS_ILH_LAS/CAM/8CAM1.state
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1h_n10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2h_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_n10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_motorV_limit
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_motorH_limit
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_H_Down
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2v_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_p10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2v_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2v_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorH_limit
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorH_pos
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1h_p10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1_V_Up
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.Calibrate
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1v_p100
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.all_OFF
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.exp
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorV_limit
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1V_Status
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_motorV_pos
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2v_p10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_H_Down
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1V_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_p10
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1v_n100
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2_V_Down
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L2V_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2v_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2v_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_H_Up
- Macro-EXP_beamCtrl-f2c89571-59bb-4b74-8c98-cabbe813e0a3-EXPBeamctrl.L1H_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_p10

#### EXP_1030nm_BEAM_POS_ALL

projects: | Instrument_Timing_and_Status

- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_motorV_pos
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.Calibrate
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.all_OFF
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_motorH_pos
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_H_Down
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_H_Up
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_V_Up
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_V_Up
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2v_n100
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_motorH_limit
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1h_p100
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_motorH_pos
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_motorV_limit
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_H_Up
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_motorH_limit
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_V_Down
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1h_n100
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2h_n10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1v_n100
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2V_Status
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1v_p10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2h_p100
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1V_Status
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2v_p10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2H_Status
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_H_Down
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2v_n10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_motorV_pos
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.all_ON
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1H_Status
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1h_p10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.exp
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1_V_Down
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1h_n10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1v_n10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2h_n100
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2h_p10
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L1v_p100
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2_motorV_limit
- Macro-EXP_uncomp_beamCtrl-121db62b-9c41-48b1-b8ad-3bfc60d10d33-EXPUncompBeamctrl.L2v_p100

#### sync_template

projects: | TESTS

- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Ref_RF_HARMONIC
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.LSU_ODL_lock_position_steps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_En
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.FB_Reference
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_Timing_shifter_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Save
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Ref_OXC
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.RF_harmonic_phase_fs
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Restore
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.lSet
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Timing_shifter_offset_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Clear
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Timestamp
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Status
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_LSU_ODL_lock_position_steps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Save_Restore_Status
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_Timing_shifter_offset_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_State
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Curr_OXC_ODL_position_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_signal_fs
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Stop
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.Timing_shifter_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.OXC_ODL_position_ps
- Macro-ppl_synch-aa5571fa-5f9c-44ce-8fb4-4f7cdf282adc-PplSynch.SFB_Dis

#### GentecEnergyMeter

projects: | LA2_NOPA

- LA2_LAS_PPL/ASENS/GENTEC_EMETER_NOPA.value
- LA2_LAS_PPL/ASENS/GENTEC_EMETER_NOPA.measurement
- LA2_LAS_PPL/ASENS/GENTEC_EMETER_AMPHOS.measurement

Read the Docs v: latest

Versions
  latest

Downloads
  html

On Read the Docs
  Project Home
  Builds

Free document hosting provided by Read the Docs.