LA3¶
LA3¶
LAS¶
PPL¶
ACTRL¶
GUIDELASER_SCS_CTL_OUT¶
| Instance id: | LA3_LAS_PPL/ACTRL/GUIDELASER_SCS_CTL_OUT |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
GUIDELASER_SQS_CTL_OUT¶
| Instance id: | LA3_LAS_PPL/ACTRL/GUIDELASER_SQS_CTL_OUT |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/HYGROMETER_1_HUMIDITY |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/HYGROMETER_1_TEMPERATURE |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | Temperature and Humidity, test |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/INPUT1 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/INPUT2 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/INPUT3 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/INPUT4 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
OUTPUT_1¶
| Instance id: | LA3_LAS_PPL/ACTRL/OUTPUT_1 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/OUTPUT_2 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/OUTPUT_3 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ACTRL/OUTPUT_4 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
ASENS¶
EMETER_AMPHOS_DIAG¶
EMETER_NOPA_SCS_OUT¶
| Instance id: | LA3_LAS_PPL/ASENS/EMETER_NOPA_SCS_OUT |
|---|---|
| Host: | exflcon126 |
| Alias: | la3-rr-ppl-con-1 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/energyMax |
| Last modified: | 2020-03-03T13:10:39.000+01:00 |
| Created at: | 2016-12-08T19:16:15.000+01:00 |
| Main authors: | Parenti, Ehsan, Giovanetti |
| Latest tag: | 1.0.6-2.7.2 |
| Deployment tag: | 1.0.5-2.2.4 |
| Installed tag: | 1.0.5-2.2.4 |
| Scenes: | SCS 3rd Stage |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
| Created: | 2020-03-03T12:11:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Update DEPENDS + test platforms |
| Created: | 2018-06-28T06:47:57.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | updated SCPI tag dependency |
| Created: | 2018-03-05T13:20:52.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2018-02-14T09:44:46.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-11-27T11:55:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add tests and CI configuration |
| Created: | 2017-11-02T14:12:59.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-01-07T21:24:17.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | tagged before deployment in LA1 |
| Created: | 2016-07-22T10:51:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Package energyMax got tagged from “branches/1.0-1.4” to “tags/1.0.0-1.4” via karabo script |
| Created: | 2014-06-17T14:18:19.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | creating release tag 1.0.1 |
| Created: | 2014-04-09T09:37:02.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | releasing tagged version 1.0.0 |
EMETER_NOPA_SQS_OUT¶
| Instance id: | LA3_LAS_PPL/ASENS/EMETER_NOPA_SQS_OUT |
|---|---|
| Host: | exflcon126 |
| Alias: | la3-rr-ppl-con-1 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/energyMax |
| Last modified: | 2020-03-03T13:10:39.000+01:00 |
| Created at: | 2016-12-08T19:16:15.000+01:00 |
| Main authors: | Parenti, Ehsan, Giovanetti |
| Latest tag: | 1.0.6-2.7.2 |
| Deployment tag: | 1.0.5-2.2.4 |
| Installed tag: | 1.0.5-2.2.4 |
| Scenes: | SQS_3rd_stage |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
| Created: | 2020-03-03T12:11:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Update DEPENDS + test platforms |
| Created: | 2018-06-28T06:47:57.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | updated SCPI tag dependency |
| Created: | 2018-03-05T13:20:52.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2018-02-14T09:44:46.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-11-27T11:55:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add tests and CI configuration |
| Created: | 2017-11-02T14:12:59.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-01-07T21:24:17.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | tagged before deployment in LA1 |
| Created: | 2016-07-22T10:51:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Package energyMax got tagged from “branches/1.0-1.4” to “tags/1.0.0-1.4” via karabo script |
| Created: | 2014-06-17T14:18:19.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | creating release tag 1.0.1 |
| Created: | 2014-04-09T09:37:02.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | releasing tagged version 1.0.0 |
EMETER_UNCOMP_SCS_OUT¶
| Instance id: | LA3_LAS_PPL/ASENS/EMETER_UNCOMP_SCS_OUT |
|---|---|
| Host: | exflcon126 |
| Alias: | la3-rr-ppl-con-1 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/energyMax |
| Last modified: | 2020-03-03T13:10:39.000+01:00 |
| Created at: | 2016-12-08T19:16:15.000+01:00 |
| Main authors: | Parenti, Ehsan, Giovanetti |
| Latest tag: | 1.0.6-2.7.2 |
| Deployment tag: | 1.0.5-2.2.4 |
| Installed tag: | 1.0.5-2.2.4 |
| Scenes: | SCS 1030 Status Scene, SCS 1030 Uncompressed Beam |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
| Created: | 2020-03-03T12:11:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Update DEPENDS + test platforms |
| Created: | 2018-06-28T06:47:57.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | updated SCPI tag dependency |
| Created: | 2018-03-05T13:20:52.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2018-02-14T09:44:46.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-11-27T11:55:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add tests and CI configuration |
| Created: | 2017-11-02T14:12:59.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-01-07T21:24:17.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | tagged before deployment in LA1 |
| Created: | 2016-07-22T10:51:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Package energyMax got tagged from “branches/1.0-1.4” to “tags/1.0.0-1.4” via karabo script |
| Created: | 2014-06-17T14:18:19.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | creating release tag 1.0.1 |
| Created: | 2014-04-09T09:37:02.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | releasing tagged version 1.0.0 |
EMETER_UNCOMP_SQS_OUT¶
| Instance id: | LA3_LAS_PPL/ASENS/EMETER_UNCOMP_SQS_OUT |
|---|---|
| Host: | exflcon126 |
| Alias: | la3-rr-ppl-con-1 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/energyMax |
| Last modified: | 2020-03-03T13:10:39.000+01:00 |
| Created at: | 2016-12-08T19:16:15.000+01:00 |
| Main authors: | Parenti, Ehsan, Giovanetti |
| Latest tag: | 1.0.6-2.7.2 |
| Deployment tag: | 1.0.5-2.2.4 |
| Installed tag: | 1.0.5-2.2.4 |
| Scenes: | SQS-1030-Status-Scene, SQS 1030 Beam |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
| Created: | 2020-03-03T12:11:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Update DEPENDS + test platforms |
| Created: | 2018-06-28T06:47:57.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | updated SCPI tag dependency |
| Created: | 2018-03-05T13:20:52.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2018-02-14T09:44:46.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-11-27T11:55:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add tests and CI configuration |
| Created: | 2017-11-02T14:12:59.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2017-01-07T21:24:17.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | tagged before deployment in LA1 |
| Created: | 2016-07-22T10:51:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Package energyMax got tagged from “branches/1.0-1.4” to “tags/1.0.0-1.4” via karabo script |
| Created: | 2014-06-17T14:18:19.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | creating release tag 1.0.1 |
| Created: | 2014-04-09T09:37:02.000Z |
|---|---|
| Author: | Majank Kumar |
| Notes: | releasing tagged version 1.0.0 |
GUIDELASER_SCS_MOD_IN¶
| Instance id: | LA3_LAS_PPL/ASENS/GUIDELASER_SCS_MOD_IN |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
GUIDELASER_SQS_MOD_IN¶
| Instance id: | LA3_LAS_PPL/ASENS/GUIDELASER_SQS_MOD_IN |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
EMETER_NOPA_SCS_3¶
EMETER_NOPA_SQS_3¶
EMETER_SCS_1030¶
EMETER_SQS_1030¶
EMETR_AMPHOS_DIAG¶
GENTEC_EMETR_AMPHOS¶
CAM¶
AC_SCS_DIAG¶
AC_SQS_DIAG¶
AMPHOS_DIAG_FF¶
| Instance id: | LA3_LAS_PPL/CAM/AMPHOS_DIAG_FF |
|---|---|
| Host: | exflcon199 |
| Class documentation: | |
| LimaBaslerCamera | |
| Alias: | la3-rr-ppl-con-3 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras |
| Last modified: | 2020-02-19T15:00:57.000+01:00 |
| Created at: | 2017-01-06T16:32:44.000+01:00 |
| Main authors: | Parenti, Kirienko, Giovanetti |
| Latest tag: | 5.6.2-2.7.1 |
| Deployment tag: | 5.5.11-2.6.2 |
| Installed tag: | 5.5.11-2.6.2 |
| Scenes: | Amphos Diagnostic cameras , LA3_LAS_PPL/CAM/AMPHOS_DIAG_FF |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The documentation of the Karabo devices for GenICam cameras can be found here
The documentation of the Karabo device for Basler cameras can be found here
| Created: | 2020-02-19T14:29:17.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Use imageSourcePy 1.0.1-2.7.1 |
| Created: | 2020-01-10T09:34:31.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Just refactoring - no functional change. |
| Created: | 2020-01-08T08:03:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-11-25T10:18:38.000Z |
|---|---|
| Author: | Christopher Youngman |
| Notes: |
| Created: | 2019-10-22T12:34:02.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX frame rate calculation |
| Created: | 2019-10-16T13:56:44.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-09-02T15:37:15.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-08-22T10:25:58.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Load configuration upon connection |
| Created: | 2019-08-13T10:22:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add support to Ubuntu 18.04 |
| Created: | 2019-07-17T08:42:52.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1 |
| Created: | 2019-06-17T10:54:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX options for read-only parameters |
| Created: | 2019-06-05T14:50:41.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add frameRateOut parameter |
| Created: | 2019-03-06T13:25:32.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Do not block the newImage callback |
| Created: | 2018-11-13T13:58:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Same as 5.5.1-2.2.6, but for Python 3.6 |
| Created: | 2018-10-25T12:04:01.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix DAQ output schema for rotated images |
| Created: | 2018-10-25T09:22:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2018-09-26T13:13:49.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-06-11T10:11:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix image rotation |
| Created: | 2018-04-26T12:15:59.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Quick fix for the 8-bit Basler image display issue |
| Created: | 2018-04-20T07:40:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AMPHOS_DIAG_NF¶
| Instance id: | LA3_LAS_PPL/CAM/AMPHOS_DIAG_NF |
|---|---|
| Host: | exflcon199 |
| Class documentation: | |
| LimaBaslerCamera | |
| Alias: | la3-rr-ppl-con-3 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras |
| Last modified: | 2020-02-19T15:00:57.000+01:00 |
| Created at: | 2017-01-06T16:32:44.000+01:00 |
| Main authors: | Parenti, Kirienko, Giovanetti |
| Latest tag: | 5.6.2-2.7.1 |
| Deployment tag: | 5.5.11-2.6.2 |
| Installed tag: | 5.5.11-2.6.2 |
| Scenes: | Amphos Diagnostic cameras , LA3_LAS_PPL/CAM/AMPHOS_DIAG_NF |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The documentation of the Karabo devices for GenICam cameras can be found here
The documentation of the Karabo device for Basler cameras can be found here
| Created: | 2020-02-19T14:29:17.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Use imageSourcePy 1.0.1-2.7.1 |
| Created: | 2020-01-10T09:34:31.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Just refactoring - no functional change. |
| Created: | 2020-01-08T08:03:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-11-25T10:18:38.000Z |
|---|---|
| Author: | Christopher Youngman |
| Notes: |
| Created: | 2019-10-22T12:34:02.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX frame rate calculation |
| Created: | 2019-10-16T13:56:44.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-09-02T15:37:15.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-08-22T10:25:58.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Load configuration upon connection |
| Created: | 2019-08-13T10:22:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add support to Ubuntu 18.04 |
| Created: | 2019-07-17T08:42:52.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1 |
| Created: | 2019-06-17T10:54:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX options for read-only parameters |
| Created: | 2019-06-05T14:50:41.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add frameRateOut parameter |
| Created: | 2019-03-06T13:25:32.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Do not block the newImage callback |
| Created: | 2018-11-13T13:58:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Same as 5.5.1-2.2.6, but for Python 3.6 |
| Created: | 2018-10-25T12:04:01.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix DAQ output schema for rotated images |
| Created: | 2018-10-25T09:22:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2018-09-26T13:13:49.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-06-11T10:11:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix image rotation |
| Created: | 2018-04-26T12:15:59.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Quick fix for the 8-bit Basler image display issue |
| Created: | 2018-04-20T07:40:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AMPHOS_INPUT_NF¶
FE_XF1_FF¶
FE_XF1_NF¶
FE_XF2_NF¶
GALVO_SCS¶
GALVO_SQS¶
NOPA_SCS_1¶
NOPA_SCS_2¶
NOPA_SCS_SEED¶
NOPA_SQS_1¶
NOPA_SQS_2¶
NOPA_SQS_SEED¶
SCS_BeamPipe¶
| Instance id: | LA3_LAS_PPL/CAM/SCS_BeamPipe |
|---|---|
| Host: | exflcon128 |
| Class documentation: | |
| LimaBaslerCamera | |
| Alias: | la3-rr-sys-con-gui2 , la3-rr-ppl-con-2 , la3-gui2 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras |
| Last modified: | 2020-02-19T15:00:57.000+01:00 |
| Created at: | 2017-01-06T16:32:44.000+01:00 |
| Main authors: | Parenti, Kirienko, Giovanetti |
| Latest tag: | 5.6.2-2.7.1 |
| Deployment tag: | 5.5.11-2.6.2 |
| Installed tag: | 5.5.11-2.6.2 |
| Scenes: | LA3_LAS_PPL/SCS_Instr_Output |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The documentation of the Karabo devices for GenICam cameras can be found here
The documentation of the Karabo device for Basler cameras can be found here
| Created: | 2020-02-19T14:29:17.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Use imageSourcePy 1.0.1-2.7.1 |
| Created: | 2020-01-10T09:34:31.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Just refactoring - no functional change. |
| Created: | 2020-01-08T08:03:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-11-25T10:18:38.000Z |
|---|---|
| Author: | Christopher Youngman |
| Notes: |
| Created: | 2019-10-22T12:34:02.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX frame rate calculation |
| Created: | 2019-10-16T13:56:44.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-09-02T15:37:15.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-08-22T10:25:58.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Load configuration upon connection |
| Created: | 2019-08-13T10:22:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add support to Ubuntu 18.04 |
| Created: | 2019-07-17T08:42:52.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1 |
| Created: | 2019-06-17T10:54:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX options for read-only parameters |
| Created: | 2019-06-05T14:50:41.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add frameRateOut parameter |
| Created: | 2019-03-06T13:25:32.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Do not block the newImage callback |
| Created: | 2018-11-13T13:58:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Same as 5.5.1-2.2.6, but for Python 3.6 |
| Created: | 2018-10-25T12:04:01.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix DAQ output schema for rotated images |
| Created: | 2018-10-25T09:22:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2018-09-26T13:13:49.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-06-11T10:11:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix image rotation |
| Created: | 2018-04-26T12:15:59.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Quick fix for the 8-bit Basler image display issue |
| Created: | 2018-04-20T07:40:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SCS_UNCOMP¶
| Instance id: | LA3_LAS_PPL/CAM/SCS_UNCOMP |
|---|---|
| Host: | exflcon128 |
| Class documentation: | |
| LimaBaslerCamera | |
| Alias: | la3-rr-sys-con-gui2 , la3-rr-ppl-con-2 , la3-gui2 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras |
| Last modified: | 2020-02-19T15:00:57.000+01:00 |
| Created at: | 2017-01-06T16:32:44.000+01:00 |
| Main authors: | Parenti, Kirienko, Giovanetti |
| Latest tag: | 5.6.2-2.7.1 |
| Deployment tag: | 5.5.11-2.6.2 |
| Installed tag: | 5.5.11-2.6.2 |
| Scenes: | SCS 1030 Status Scene, SCS 1030 Uncompressed Beam |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The documentation of the Karabo devices for GenICam cameras can be found here
The documentation of the Karabo device for Basler cameras can be found here
| Created: | 2020-02-19T14:29:17.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Use imageSourcePy 1.0.1-2.7.1 |
| Created: | 2020-01-10T09:34:31.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Just refactoring - no functional change. |
| Created: | 2020-01-08T08:03:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-11-25T10:18:38.000Z |
|---|---|
| Author: | Christopher Youngman |
| Notes: |
| Created: | 2019-10-22T12:34:02.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX frame rate calculation |
| Created: | 2019-10-16T13:56:44.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-09-02T15:37:15.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-08-22T10:25:58.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Load configuration upon connection |
| Created: | 2019-08-13T10:22:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add support to Ubuntu 18.04 |
| Created: | 2019-07-17T08:42:52.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1 |
| Created: | 2019-06-17T10:54:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX options for read-only parameters |
| Created: | 2019-06-05T14:50:41.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add frameRateOut parameter |
| Created: | 2019-03-06T13:25:32.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Do not block the newImage callback |
| Created: | 2018-11-13T13:58:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Same as 5.5.1-2.2.6, but for Python 3.6 |
| Created: | 2018-10-25T12:04:01.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix DAQ output schema for rotated images |
| Created: | 2018-10-25T09:22:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2018-09-26T13:13:49.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-06-11T10:11:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix image rotation |
| Created: | 2018-04-26T12:15:59.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Quick fix for the 8-bit Basler image display issue |
| Created: | 2018-04-20T07:40:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SQS_BeamPipe¶
| Instance id: | LA3_LAS_PPL/CAM/SQS_BeamPipe |
|---|---|
| Host: | exflcon199 |
| Class documentation: | |
| LimaBaslerCamera | |
| Alias: | la3-rr-ppl-con-3 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras |
| Last modified: | 2020-02-19T15:00:57.000+01:00 |
| Created at: | 2017-01-06T16:32:44.000+01:00 |
| Main authors: | Parenti, Kirienko, Giovanetti |
| Latest tag: | 5.6.2-2.7.1 |
| Deployment tag: | 5.5.11-2.6.2 |
| Installed tag: | 5.5.11-2.6.2 |
| Scenes: | SQS_Instr_Output, LA3_LAS_PPL/SQS_Instr_Output |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The documentation of the Karabo devices for GenICam cameras can be found here
The documentation of the Karabo device for Basler cameras can be found here
| Created: | 2020-02-19T14:29:17.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Use imageSourcePy 1.0.1-2.7.1 |
| Created: | 2020-01-10T09:34:31.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Just refactoring - no functional change. |
| Created: | 2020-01-08T08:03:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-11-25T10:18:38.000Z |
|---|---|
| Author: | Christopher Youngman |
| Notes: |
| Created: | 2019-10-22T12:34:02.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX frame rate calculation |
| Created: | 2019-10-16T13:56:44.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-09-02T15:37:15.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-08-22T10:25:58.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Load configuration upon connection |
| Created: | 2019-08-13T10:22:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add support to Ubuntu 18.04 |
| Created: | 2019-07-17T08:42:52.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1 |
| Created: | 2019-06-17T10:54:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX options for read-only parameters |
| Created: | 2019-06-05T14:50:41.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add frameRateOut parameter |
| Created: | 2019-03-06T13:25:32.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Do not block the newImage callback |
| Created: | 2018-11-13T13:58:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Same as 5.5.1-2.2.6, but for Python 3.6 |
| Created: | 2018-10-25T12:04:01.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix DAQ output schema for rotated images |
| Created: | 2018-10-25T09:22:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2018-09-26T13:13:49.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-06-11T10:11:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix image rotation |
| Created: | 2018-04-26T12:15:59.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Quick fix for the 8-bit Basler image display issue |
| Created: | 2018-04-20T07:40:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SQS_UNCOMP¶
| Instance id: | LA3_LAS_PPL/CAM/SQS_UNCOMP |
|---|---|
| Host: | exflcon128 |
| Class documentation: | |
| LimaBaslerCamera | |
| Alias: | la3-rr-sys-con-gui2 , la3-rr-ppl-con-2 , la3-gui2 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/limaCameras |
| Last modified: | 2020-02-19T15:00:57.000+01:00 |
| Created at: | 2017-01-06T16:32:44.000+01:00 |
| Main authors: | Parenti, Kirienko, Giovanetti |
| Latest tag: | 5.6.2-2.7.1 |
| Deployment tag: | 5.5.11-2.6.2 |
| Installed tag: | 5.5.11-2.6.2 |
| Scenes: | SQS-1030-Status-Scene, SQS 1030 Beam |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The documentation of the Karabo devices for GenICam cameras can be found here
The documentation of the Karabo device for Basler cameras can be found here
| Created: | 2020-02-19T14:29:17.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Use imageSourcePy 1.0.1-2.7.1 |
| Created: | 2020-01-10T09:34:31.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Just refactoring - no functional change. |
| Created: | 2020-01-08T08:03:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-11-25T10:18:38.000Z |
|---|---|
| Author: | Christopher Youngman |
| Notes: |
| Created: | 2019-10-22T12:34:02.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX frame rate calculation |
| Created: | 2019-10-16T13:56:44.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-09-02T15:37:15.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-08-22T10:25:58.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Load configuration upon connection |
| Created: | 2019-08-13T10:22:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add support to Ubuntu 18.04 |
| Created: | 2019-07-17T08:42:52.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Only to be used with Karabo 2.5.0, as it works-around a bug in ImageData, which will be fixed in 2.5.1 |
| Created: | 2019-06-17T10:54:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX options for read-only parameters |
| Created: | 2019-06-05T14:50:41.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add frameRateOut parameter |
| Created: | 2019-03-06T13:25:32.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Do not block the newImage callback |
| Created: | 2018-11-13T13:58:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Same as 5.5.1-2.2.6, but for Python 3.6 |
| Created: | 2018-10-25T12:04:01.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix DAQ output schema for rotated images |
| Created: | 2018-10-25T09:22:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2018-09-26T13:13:49.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-06-11T10:11:46.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix image rotation |
| Created: | 2018-04-26T12:15:59.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Quick fix for the 8-bit Basler image display issue |
| Created: | 2018-04-20T07:40:11.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
TEM_XF1_FF¶
AC_XF2_DIAG¶
NOPA_SCS_3¶
NOPA_SQS_3¶
AMPHOS_FF¶
AMPHOS_NF¶
SCS_1030¶
SCS_BEAMPIPE¶
SQS_1030¶
SQS_BEAMPIPE¶
AMPHOS_SIDEPORT¶
DCTRL¶
CHILLER_REMOTESTART¶
| Instance id: | LA3_LAS_PPL/DCTRL/CHILLER_REMOTESTART |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
GUIDELASER_SCS_LD_REM¶
| Instance id: | LA3_LAS_PPL/DCTRL/GUIDELASER_SCS_LD_REM |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/DCTRL/GUIDELASER_SCS_LD_REM |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
GUIDELASER_SQS_LD_REM¶
| Instance id: | LA3_LAS_PPL/DCTRL/GUIDELASER_SQS_LD_REM |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/DCTRL/GUIDELASER_SQS_LD_REM |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ENC/CMCOMPSTAGE |
|---|---|
| Class id: | BeckhoffEncoder |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffEncoder | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | cmStageMotor, 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ENC/DMCOMPSTAGE |
|---|---|
| Class id: | BeckhoffEncoder |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffEncoder | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ENC/NANOSSPARE1 |
|---|---|
| Class id: | BeckhoffEncoder |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffEncoder | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SCS_1¶
| Instance id: | LA3_LAS_PPL/ENC/TRACEYCOMP_SCS_1 |
|---|---|
| Class id: | BeckhoffEncoder |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffEncoder | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SCS_2¶
| Instance id: | LA3_LAS_PPL/ENC/TRACEYCOMP_SCS_2 |
|---|---|
| Class id: | BeckhoffEncoder |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffEncoder | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SQS_1¶
| Instance id: | LA3_LAS_PPL/ENC/TRACEYCOMP_SQS_1 |
|---|---|
| Class id: | BeckhoffEncoder |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffEncoder | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SQS_2¶
| Instance id: | LA3_LAS_PPL/ENC/TRACEYCOMP_SQS_2 |
|---|---|
| Class id: | BeckhoffEncoder |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffEncoder | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/GAUGE/BEAMPIPE_SCS |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | Vacuum-Monitoring, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
BEAMPIPE_SQS¶
| Instance id: | LA3_LAS_PPL/GAUGE/BEAMPIPE_SQS |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | Vacuum-Monitoring, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/MDL/BECKHOFF_MONITOR |
|---|---|
| Class id: | BeckhoffMonitor |
| Host: | la3-rr-ppl-con-1 |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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: | LA3_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!
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
- The heartbeat interval
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
- This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
- Configures who is allowed to see this device at all
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server
- pid:
- The unix process ID of the device (i.e. of the server)
- state:
- The current state the device is in
- status:
- A more detailed status description
- lockedBy:
- The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
- Clear the lock 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
| Created: | 2021-05-20T19:08:59.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: | Adapted to Python 3.8.x. No new features. |
| 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 |
| Created: | 2020-11-16T10:27:47.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Indicate 2.10 compatibility |
| Created: | 2019-05-28T11:54:20.000+02:00 |
|---|---|
| Author: | Yury Kirienko |
| Notes: | State handling enhanced |
| Created: | 2019-05-21T13:20:15.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| 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 |
| Created: | 2019-04-30T14:17:25.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Added variables to SD_MC2BECKHOFF |
| Created: | 2019-04-30T10:50:21.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Bug-fix: State error handled: redmine #32841 |
| Created: | 2019-03-11T16:27:14.000+01:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Compatibility with new beckhoff methods to retrieve schema |
| Created: | 2018-11-06T17:39:58.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | PLC config saved in git repo |
| Created: | 2018-09-05T12:40:28.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Optimized Saving of PLC device config |
| Created: | 2018-06-15T17:56:09.000+02:00 |
|---|---|
| Author: | rfabbri |
| Notes: | working xml download |
| Created: | 2018-02-05T11:06:05.000+01:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-02-05T11:06:05.000+01:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-01-17T14:05:28.000+01:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-01-16T16:01:25.000+01:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-01-16T14:55:02.000+01:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-01-15T18:00:15.000+01:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2018-01-15T17:46:45.000+01:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
CAM_WATCHDOG¶
CHILLER_MONITOR¶
PPL_INFOS_SCS¶
PPL_INFOS_SQS¶
MULTI_PATTERN¶
| Instance id: | LA3_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: | 2021-02-15T16:24:04.000+01:00 |
| Created at: | 2018-08-06T14:02:03.000+02:00 |
| Main authors: | Fabbri, Haufs |
| Latest tag: | 1.5.6-2.10.0 |
| Deployment tag: | 1.5.6-2.10.0 |
| Installed tag: | 1.5.6-2.10.0 |
| Scenes: | LA3_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern, LA3_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern |
| Accessible by: | CONTROLS, CTRL, DA, danilevc, tjezynsk, xdoc |
Warning
Rogue installation which is not mentioned in the deployment!
Warning
Device is installed in development mode!
Warning
Might be hot-fixed, dt=55 days, 22:17:00!
The PplMultiSubPattern device is documented in
pplPattern:welcome
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
- The heartbeat interval
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
- This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
- Configures who is allowed to see this device at all
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server
- pid:
- The unix process ID of the device (i.e. of the server)
- state:
- The current state the device is in
- status:
- A more detailed status description
- lockedBy:
- The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
- Clear the lock 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
| Created: | 2021-02-09T09:18:53.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Add Karabo 2.10 Versioning Info |
| Created: | 2020-08-17T12:00:55.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Aligned with timeserver change (output is now DAQ compatible). |
| Created: | 2020-08-17T11:01:20.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Input Channel implemented. |
| Created: | 2020-07-24T16:32:20.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | PplOverview: Bug/Fix when comparing arrays in decode_bunch_pattern. |
| Created: | 2020-07-23T14:32:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Implemented interval for pattern refresh. |
| Created: | 2020-06-30T11:44:20.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Merge of similar functions. |
| 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). |
| Created: | 2020-06-29T09:28:47.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | The update of key isOnPplGrid is independent from update of key isPeriodic. |
| Created: | 2020-06-11T08:41:52.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Updated dependencies on doocsapi and euxfel_bunch_pattern. |
| Created: | 2020-04-03T14:55:23.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Branch Feat/Refactoring merged to master |
| Created: | 2020-04-03T14:17:18.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: Label changed and keys moved |
| Created: | 2020-04-03T09:05:29.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: Obsolete intermediate steps removed for clarity |
| Created: | 2020-04-01T17:26:11.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: Fix/remove not needed code in bases |
| Created: | 2020-04-01T13:58:54.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: DaqPolicy updated |
| Created: | 2020-04-01T09:30:46.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: Align Unittest |
| 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 |
| Created: | 2020-03-31T10:14:55.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: Optimizing code in _setter_periodic_pattern |
| Created: | 2020-03-30T08:27:16.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: Remove redundant index column in lookup table |
| Created: | 2020-03-30T08:23:50.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: overview: Align scene with new totEmptyBunches key |
| Created: | 2020-03-30T07:24:56.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Refactoring: Distinguish empty types: inter-pulses only and all empties in a subpattern |
PATTERNS_OVERVIEW¶
ADC_PEAKPOS_TEST¶
USER_STARTER¶
TEM_XF1_OVERVIEW¶
TEM_XF2_SQS_OVERVIEW¶
NOPA_AMP_OVERVIEW_SCS¶
PPL_OVERVIEW¶
TEM_XF2_SCS_OVERVIEW¶
AMPHOS_OVERVIEW¶
GALVO_OVERVIEW¶
FE_OVERVIEW¶
MOTOR¶
CYLLENS_SCS_FA¶
| Instance id: | LA3_LAS_PPL/MOTOR/CYLLENS_SCS_FA |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/CYLLENS_SCS_FA |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
CYLLENS_SCS_SA¶
| Instance id: | LA3_LAS_PPL/MOTOR/CYLLENS_SCS_SA |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
CYLLENS_SQS_FA¶
| Instance id: | LA3_LAS_PPL/MOTOR/CYLLENS_SQS_FA |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/CYLLENS_SQS_SA |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
CYLLENS_SQS_SA¶
| Instance id: | LA3_LAS_PPL/MOTOR/CYLLENS_SQS_SA |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/MOTOR/CYL_LENS_STAGE_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/MOTOR/CYL_LENS_STAGE_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/MOTOR/ROT_SPARE_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/ROT_SPARE_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/MOTOR/ROT_SPARE_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/ROT_SPARE_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SCS_2, LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SCS_3, LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SCS_1, LA3_LAS_PPLMOTORSPECTUNE_NOPA_SCS, LA3_LAS_PPLMOTORSPECTUNE_NOPA_SCS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SQS_2, LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SQS_3, LA3_LAS_PPL/MOTOR/SPECTUNE_NOPA_SQS_1, LA3_LAS_PPLMOTORSPECTUNE_NOPA_SQS, LA3_LAS_PPL/MOTOR_SPECTUNE_NOPA_SQS |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_DIAG_SCS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | SCSdmRFSignal, LA3_LAS_PPLMOTORWP_SCS_DIAG |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_DIAG_SQS |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | SQSdmRFSignal, LA3_LAS_PPLMOTORWP_SQS_DIAG |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS_1¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_NOPA_SCS_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/WP_NOPA_SCS_1, LA3_LAS_PPL_MOTOR_WP_NOPA_SCS_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS_2¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_NOPA_SCS_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/WP_NOPA_SCS_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SCS_3¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_NOPA_SCS_3 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/WP_NOPA_SCS_3 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS_1¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_NOPA_SQS_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL_MOTOR_WP_NOPA_SQS_1, LA3_LAS_PPL/MOTOR/WP_NOPA_SQS_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS_2¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_NOPA_SQS_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/WP_NOPA_SQS_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SQS_3¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_NOPA_SQS_3 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/MOTOR/WP_NOPA_SQS_3 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SCS_1¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SCS_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL-MOTOR-WP_SCS_1, LA3_LAS_PPL/MOTOR/WP_SCS_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SCS_2¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SCS_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL-MOTOR-WP_SCS_2, LA3_LAS_PPL/MOTOR/WP_SCS_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SCS_CR_1¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SCS_CR_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPLMOTORWP_SCS_CR_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SCS_CR_2¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SCS_CR_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPLMOTORWP_SCS_CR_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SCS_CR_3¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SCS_CR_3 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPLMOTORWP_SCS_CR_3 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SQS_1¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SQS_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL-MOTOR-WP_SQS_1, LA3_LAS_PPL/MOTOR/WP_SQS_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SQS_2¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SQS_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL-MOTOR-WP_SQS_2, LA3_LAS_PPL/MOTOR/WP_SQS_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SQS_CR_1¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SQS_CR_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPLMOTORWP_SQS_CR_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SQS_CR_2¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SQS_CR_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPLMOTORWP_SQS_CR_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
WP_SQS_CR_3¶
| Instance id: | LA3_LAS_PPL/MOTOR/WP_SQS_CR_3 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPLMOTORWP_SQS_CR_3 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/MOTOR/WP_TEM |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | TEM XF1, LA3_LAS_PPL/MOTOR/WP_TEM, 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
PLC¶
COM¶
| Instance id: | LA3_LAS_PPL/PLC/COM |
|---|---|
| Class id: | BeckhoffCom |
| Host: | la3-rr-ppl-con-1 |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/PLC/COM_PLCMON |
|---|---|
| Class id: | BeckhoffPlcMonitor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffPlcMonitor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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¶
| Instance id: | LA3_LAS_PPL/PMOTOR/CMCOMPSTAGE |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | cmStageMotor, LA3_LAS_PPL/PMOTOR/CMCOMPSTAGE |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
CMCOMPSTAGE_RESET¶
| Instance id: | LA3_LAS_PPL/PMOTOR/CMCOMPSTAGE_RESET |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/PMOTOR/DMCOMPSTAGE |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | SQS BCC and spectrum, dmStageMotor, SCS Spectrum and BCC, LA3_LAS_PPL/PMOTOR/DMCOMPSTAGE |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/PMOTOR/DMCOMPSTAGE_RESET |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/PMOTOR/NANOSSPARE1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/PMOTOR/NANOSSPARE1 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/PMOTOR/NANOSSPARE1_RESET |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SCS_1¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SCS_1_RESET¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_1_RESET |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SCS_2¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SCS_2_RESET¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_2_RESET |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SQS_1¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | TreacyComSQS, LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SQS_1_RESET¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_1_RESET |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SQS_2¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | TreacyComSQS, LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_2 |
| 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TRACEYCOMP_SQS_2_RESET¶
| Instance id: | LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_2_RESET |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
PROC¶
AC_SCS_DIAG¶
| Instance id: | LA3_LAS_PPL/PROC/AC_SCS_DIAG |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | LA3_LAS_PPL/CAM/AC_SCS_DIAG |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AC_XF2_DIAG¶
| Instance id: | LA3_LAS_PPL/PROC/AC_XF2_DIAG |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | After XF2 compressor |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AMPHOS_DIAG_FF_PROC¶
| Instance id: | LA3_LAS_PPL/PROC/AMPHOS_DIAG_FF_PROC |
|---|---|
| Host: | exflcon199 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-rr-ppl-con-3 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor |
| Last modified: | 2020-03-17T11:23:32.000+01:00 |
| Created at: | 2016-11-16T14:12:17.000+01:00 |
| Main authors: | Parenti, Giovanetti |
| Latest tag: | 1.27.1-2.8.0 |
| Deployment tag: | 1.25.0-2.6.2 |
| Installed tag: | 1.25.0-2.6.2 |
| Scenes: | Amphos Diagnostic cameras , LA3_LAS_PPL/CAM/AMPHOS_DIAG_FF |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The ImageProcessor device is documented in
imageprocessor:image-processor-user
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-19T12:53:14.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add ROI to the TwoPeakFinder device |
| Created: | 2019-02-12T09:02:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-01T15:13:24.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add twin peak finder |
| Created: | 2019-01-31T10:18:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AMPHOS_DIAG_NF_PROC¶
| Instance id: | LA3_LAS_PPL/PROC/AMPHOS_DIAG_NF_PROC |
|---|---|
| Host: | exflcon199 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-rr-ppl-con-3 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor |
| Last modified: | 2020-03-17T11:23:32.000+01:00 |
| Created at: | 2016-11-16T14:12:17.000+01:00 |
| Main authors: | Parenti, Giovanetti |
| Latest tag: | 1.27.1-2.8.0 |
| Deployment tag: | 1.25.0-2.6.2 |
| Installed tag: | 1.25.0-2.6.2 |
| Scenes: | Amphos Diagnostic cameras , LA3_LAS_PPL/CAM/AMPHOS_DIAG_NF |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The ImageProcessor device is documented in
imageprocessor:image-processor-user
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-19T12:53:14.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add ROI to the TwoPeakFinder device |
| Created: | 2019-02-12T09:02:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-01T15:13:24.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add twin peak finder |
| Created: | 2019-01-31T10:18:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AMPHOS_INPUT_NF¶
| Instance id: | LA3_LAS_PPL/PROC/AMPHOS_INPUT_NF |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | LA3_LAS_PPL/CAM/AMPHOS_INPUT_NF|scene, CAM-AMPHOS_INPUT_NF, FE_XF1-Cam-Images, FE_XF1-Pointing, LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW|overview |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
FE_XF1_FF¶
| Instance id: | LA3_LAS_PPL/PROC/FE_XF1_FF |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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 output, FE_XF1_FF, FE_XF1_FF, XF1 Far field, FE_XF1-Cam-Images, FE_XF1-Pointing |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
FE_XF1_NF¶
| Instance id: | LA3_LAS_PPL/PROC/FE_XF1_NF |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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 output, FE output NF cams, XF1_NF_CAM, XF1_NF_CAM, XF1 Near field, FE_XF1-Cam-Images, FE_XF1-Pointing |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
FE_XF2_NF¶
| Instance id: | LA3_LAS_PPL/PROC/FE_XF2_NF |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | FE output NF cams, XF2 Near field, FE_XF2_NF, FE_XF2_NF, FE_XF2-NF-Output |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
GALVO_SCS¶
| Instance id: | LA3_LAS_PPL/PROC/GALVO_SCS |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | XF1 SCS cameras, LA3_LAS_PPL/CAM/GALVO_SCS |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
GALVO_SQS¶
| Instance id: | LA3_LAS_PPL/PROC/GALVO_SQS |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | LA3_LAS_PPL/CAM/GALVO_SQS, XF1-SQS cams |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SCS_1¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SCS_1 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SCS 1st stage, LA3_LAS_PPL/CAM/NOPA_SCS_1, SCS-1st-stage_test |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SCS_2¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SCS_2 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SCS 2nd stage, SCS status scene, SCS user panel |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SCS_SEED¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SCS_SEED |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | NOPA_SCS_SEED, TEM-XF2-SQS-SCS-incl-setpoints, TEM-XF2, NOPA_SCS_SEED, TEM-XF2-CAMS-GAUSSIANFITDATA |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SQS_1¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SQS_1 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | LA3_LAS_PPL/CAM/NOPA_SQS_1, SQS 1st stage |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SQS_2¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SQS_2 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SQS user panel, SQS status scene, SQS 2nd stage |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SQS_3¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SQS_3 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SQS_3rd_stage |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SQS_SEED¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SQS_SEED |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | NOPA_SQS_SEED, TEM-XF2-SQS-SCS-incl-setpoints, TEM-XF2, NOPA_SQS_SEED, TEM-XF2-CAMS-GAUSSIANFITDATA |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SCS_UNCOMP¶
| Instance id: | LA3_LAS_PPL/PROC/SCS_UNCOMP |
|---|---|
| Host: | exflcon128 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-rr-sys-con-gui2 , la3-rr-ppl-con-2 , la3-gui2 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor |
| Last modified: | 2020-03-17T11:23:32.000+01:00 |
| Created at: | 2016-11-16T14:12:17.000+01:00 |
| Main authors: | Parenti, Giovanetti |
| Latest tag: | 1.27.1-2.8.0 |
| Deployment tag: | 1.25.0-2.6.2 |
| Installed tag: | 1.25.0-2.6.2 |
| Scenes: | SCS 1030 Status Scene, SCS 1030 Uncompressed Beam |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The ImageProcessor device is documented in
imageprocessor:image-processor-user
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-19T12:53:14.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add ROI to the TwoPeakFinder device |
| Created: | 2019-02-12T09:02:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-01T15:13:24.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add twin peak finder |
| Created: | 2019-01-31T10:18:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SQS_DIAG¶
| Instance id: | LA3_LAS_PPL/PROC/SQS_DIAG |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | LA3_LAS_PPL/CAM/SQS_DIAG, XF1-SQS cams |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SQS_UNCOMP¶
| Instance id: | LA3_LAS_PPL/PROC/SQS_UNCOMP |
|---|---|
| Host: | exflcon128 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-rr-sys-con-gui2 , la3-rr-ppl-con-2 , la3-gui2 |
| Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor |
| Last modified: | 2020-03-17T11:23:32.000+01:00 |
| Created at: | 2016-11-16T14:12:17.000+01:00 |
| Main authors: | Parenti, Giovanetti |
| Latest tag: | 1.27.1-2.8.0 |
| Deployment tag: | 1.25.0-2.6.2 |
| Installed tag: | 1.25.0-2.6.2 |
| Scenes: | SQS-1030-Status-Scene, SQS 1030 Beam |
| Accessible by: | CONTROLS, DA, WP78, brambrin, pallasf |
The ImageProcessor device is documented in
imageprocessor:image-processor-user
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-19T12:53:14.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add ROI to the TwoPeakFinder device |
| Created: | 2019-02-12T09:02:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
| Created: | 2019-02-01T15:13:24.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add twin peak finder |
| Created: | 2019-01-31T10:18:10.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
TEM_XF1_FF¶
| Instance id: | LA3_LAS_PPL/PROC/TEM_XF1_FF |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | TEM XF1, XF1out, TEM-XF1 |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
NOPA_SCS_3¶
| Instance id: | LA3_LAS_PPL/PROC/NOPA_SCS_3 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SCS 3rd Stage |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AC_SQS_DIAG¶
| Instance id: | LA3_LAS_PPL/PROC/AC_SQS_DIAG |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AMPHOS_FF¶
| Instance id: | LA3_LAS_PPL/PROC/AMPHOS_FF |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | Amphos Diagnostic cameras , LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW|overview |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
AMPHOS_NF¶
| Instance id: | LA3_LAS_PPL/PROC/AMPHOS_NF |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | Amphos Diagnostic cameras , LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW|overview |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SCS_1030¶
| Instance id: | LA3_LAS_PPL/PROC/SCS_1030 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SCS 1030 Uncompressed Beam |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SCS_BEAMPIPE¶
| Instance id: | LA3_LAS_PPL/PROC/SCS_BEAMPIPE |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SQS_1030¶
| Instance id: | LA3_LAS_PPL/PROC/SQS_1030 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon226 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SQS 1030 Beam |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
SQS_BEAMPIPE¶
| Instance id: | LA3_LAS_PPL/PROC/SQS_BEAMPIPE |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
PUMP¶
BEAMPIPES_ERROR¶
| Instance id: | LA3_LAS_PPL/PUMP/BEAMPIPES_ERROR |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/PUMP/BEAMPIPES_ON |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | Vacuum-Monitoring, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SPECPROC¶
SWITCH¶
CHILLER_COLLECTIVEALARM¶
| Instance id: | LA3_LAS_PPL/SWITCH/CHILLER_COLLECTIVEALARM |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/SWITCH/CHILLER_FLOWALARM |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/SWITCH/CHILLER_GUIDEVALUEALARM |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/SWITCH/CHILLER_PRESSUREALARM |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/SWITCH/CHILLER_TEMPERATUREALARM |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/SWITCH/CHILLER_WATERALARM |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/SWITCH/TRIGGER |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_1 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_2 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_3 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_4 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_5 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_6 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_7 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/EQUIP_8 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_1 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_2 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | Temperature @ FE, Temperature-@-FE, 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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_3 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_4 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_5 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_6 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_7 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/TSENS/TABLE_8 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
TSYS¶
TIMESERVER¶
| Instance id: | LA3_LAS_PPL/TSYS/TIMESERVER |
|---|---|
| Class id: | TimeServer |
| Host: | la3-las-sys-utc-1 |
| Class documentation: | |
| TimeServer | |
| Alias: | la3-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 |
| Accessible by: | CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc |
Warning
Rogue installation which is not mentioned in the deployment!
The Time Server device is documented in
timeServer:timeServer
To troubleshooting documentation
To Train Id workflow documentation
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The 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.
| Created: | 2021-02-10T16:51:00.000+01:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | ‘update-copied-headers’ into ‘master’ |
| Created: | 2021-02-05T11:41:17.000+01:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Fix bugs on period, C++14, fix CI |
| Created: | 2020-11-24T08:08:35.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2020-09-21T14:07:33.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Skip ticks with bad periods and added a bunch of instrumentation |
| 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. |
| Created: | 2020-07-22T16:18:32.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Added slot for toggling data processing. |
| Created: | 2020-07-08T22:40:51.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | PplBunchPatternStats: Node maxBufferLength is reconfigurable. |
| 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. |
| Created: | 2020-05-27T15:47:21.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2020-05-27T15:47:21.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Bunch patterns as digests, add a BunchPatternStats device |
| Created: | 2020-02-12T15:34:09.000+01:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Introduce average difference of id increase and add alarms to it |
| Created: | 2019-05-07T16:35:38.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Avoid System Crashes on multiple instances |
| Created: | 2019-01-23T10:01:43.000+01:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | FEAT: avoid namespace collision with pcLayer |
| Created: | 2018-12-10T14:26:22.000+01:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | added DAQ Policy |
| Created: | 2018-11-29T16:54:33.000+01:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Added read Bunch Pattern table feature |
| Created: | 2018-02-27T11:18:55.000+01:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Publish signalled trainIds to data logger |
| Created: | 2017-09-14T15:41:19.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: | Fix SIGFPE in signalHandler |
| 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. |
| Created: | 2017-08-20T14:55:53.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2017-06-12T15:43:27.000+02:00 |
|---|---|
| Author: | esenov |
| Notes: |
TIMESERVER_BSTATS_PPL¶
VALVE¶
PUMPLINE¶
| Instance id: | LA3_LAS_PPL/VALVE/PUMPLINE |
|---|---|
| Class id: | BeckhoffValve |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffValve | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SCS¶
| Instance id: | LA3_LAS_PPL/VALVE/SCS |
|---|---|
| Class id: | BeckhoffValve |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffValve | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | Vacuum-Monitoring, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/VALVE/SPARE |
|---|---|
| Class id: | BeckhoffValve |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffValve | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SQS¶
| Instance id: | LA3_LAS_PPL/VALVE/SQS |
|---|---|
| Class id: | BeckhoffValve |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffValve | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | Vacuum-Monitoring, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_LAS_PPL/VACUUM/CONTROL|default, LA3_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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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: | LA3_LAS_PPL/ADC/1 |
|---|---|
| Class id: | FastAdc |
| Host: | la3-las-sys-utc-1 |
| Class documentation: | |
| FastAdc | |
| Alias: | la3-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: | SQS user panel, RF-Signal, Raw Data, SCSdmRFSignal, SQSdmRFSignal, XF1 Diag Photodiode, CMBCC, XF2 Photodiode, SCS user panel, TRG_HIST, ADC1, PC_AOM, SCS-1st-stage_test, SQS Photodiodes |
| Accessible by: | CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc |
Warning
Rogue installation which is not mentioned in the deployment!
The FastADC device is documented in
fastadc:welcome
- 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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The 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
| Created: | 2021-07-05T18:16:26.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Update tag for utca configuration |
| Created: | 2021-07-05T14:39:35.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Add Raw frequency parameter. |
| Created: | 2021-07-05T13:49:35.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | update iibus tag (Fixed bug with 32 bit signed values_ |
| Created: | 2021-06-25T13:42:45.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers |
| Created: | 2021-06-15T19:42:44.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Fix bunch period issue |
| Created: | 2021-06-15T18:00:03.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Update depends tag |
| Created: | 2021-06-11T16:21:15.000+02:00 |
|---|---|
| Author: | Bruno Fernandes |
| Notes: | FastADC firmware 3.5.21 |
| Created: | 2021-06-09T11:37:55.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | update tag for iibus |
| Created: | 2021-06-02T18:15:10.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Fix indentation issues |
| Created: | 2021-06-02T09:25:59.000+02:00 |
|---|---|
| Author: | Bruno Fernandes |
| Notes: | Raw and peak data in Voltage levels |
| 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) |
| Created: | 2020-11-26T12:52:36.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Swapped TCLKA and TCLKB values. |
| Created: | 2020-11-24T14:31:13.000+01:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-09-23T17:43:01.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline |
| Created: | 2020-09-11T16:25:10.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Remove deprecated slots |
| Created: | 2020-09-10T10:12:17.000+02:00 |
|---|---|
| Author: | Robert Schaffer |
| Notes: | For Firmware version 3.5 |
| Created: | 2020-09-09T19:36:37.000+02:00 |
|---|---|
| Author: | Robert Schaffer |
| Notes: |
| Created: | 2019-11-26T13:38:00.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Train statistics included in special branch dedicated to laslab. |
| Created: | 2019-11-12T13:27:17.000+01:00 |
|---|---|
| Author: | Denys Mamchyk |
| Notes: | fix for “Raw Delay” and “Pulse Delay” max limits |
| Created: | 2019-07-11T09:56:32.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected |
2¶
| Instance id: | LA3_LAS_PPL/ADC/2 |
|---|---|
| Class id: | FastAdc |
| Host: | la3-las-sys-utc-1 |
| Class documentation: | |
| FastAdc | |
| Alias: | la3-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: | ADC2, SQS BCC and spectrum, dmBCCRAWDATA, SCSdmRFSignal, SQSdmRFSignal, SCS Spectrum and BCC, BCCNopaXF2 |
| Accessible by: | CONTROLS, CTRL, babies, cascella, kaned, mramilli, samartse, tjezynsk, xdoc |
Warning
Rogue installation which is not mentioned in the deployment!
The FastADC device is documented in
fastadc:welcome
- 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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The 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
| Created: | 2021-07-05T18:16:26.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Update tag for utca configuration |
| Created: | 2021-07-05T14:39:35.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Add Raw frequency parameter. |
| Created: | 2021-07-05T13:49:35.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | update iibus tag (Fixed bug with 32 bit signed values_ |
| Created: | 2021-06-25T13:42:45.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers |
| Created: | 2021-06-15T19:42:44.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Fix bunch period issue |
| Created: | 2021-06-15T18:00:03.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Update depends tag |
| Created: | 2021-06-11T16:21:15.000+02:00 |
|---|---|
| Author: | Bruno Fernandes |
| Notes: | FastADC firmware 3.5.21 |
| Created: | 2021-06-09T11:37:55.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | update tag for iibus |
| Created: | 2021-06-02T18:15:10.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Fix indentation issues |
| Created: | 2021-06-02T09:25:59.000+02:00 |
|---|---|
| Author: | Bruno Fernandes |
| Notes: | Raw and peak data in Voltage levels |
| 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) |
| Created: | 2020-11-26T12:52:36.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Swapped TCLKA and TCLKB values. |
| Created: | 2020-11-24T14:31:13.000+01:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-09-23T17:43:01.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline |
| Created: | 2020-09-11T16:25:10.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Remove deprecated slots |
| Created: | 2020-09-10T10:12:17.000+02:00 |
|---|---|
| Author: | Robert Schaffer |
| Notes: | For Firmware version 3.5 |
| Created: | 2020-09-09T19:36:37.000+02:00 |
|---|---|
| Author: | Robert Schaffer |
| Notes: |
| Created: | 2019-11-26T13:38:00.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Train statistics included in special branch dedicated to laslab. |
| Created: | 2019-11-12T13:27:17.000+01:00 |
|---|---|
| Author: | Denys Mamchyk |
| Notes: | fix for “Raw Delay” and “Pulse Delay” max limits |
| Created: | 2019-07-11T09:56:32.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected |
VACUUM¶
POE¶
AC_SCS_DIAG¶
AC_SQS_DIAG¶
AC_XF2_DIAG¶
AMPHOS_FF¶
AMPHOS_INPUT_NF¶
AMPHOS_NF¶
FE_XF1_FF¶
FE_XF1_NF¶
FE_XF2_NF¶
GALVO_SCS¶
GALVO_SQS¶
NOPA_SCS_1¶
NOPA_SCS_2¶
NOPA_SCS_3¶
NOPA_SCS_SEED¶
NOPA_SQS_1¶
NOPA_SQS_2¶
NOPA_SQS_3¶
SCS_BEAMPIPE¶
SQS_1030¶
SQS_BEAMPIPE¶
TEM_XF1_FF¶
NOPA_SQS_SEED¶
10_253_14_239_1¶
10_253_14_239_10¶
10_253_14_239_11¶
10_253_14_239_12¶
10_253_14_239_13¶
10_253_14_239_15¶
10_253_14_239_17¶
10_253_14_239_18¶
10_253_14_239_19¶
10_253_14_239_2¶
10_253_14_239_21¶
10_253_14_239_23¶
10_253_14_239_3¶
10_253_14_239_4¶
10_253_14_239_5¶
10_253_14_239_6¶
10_253_14_239_7¶
10_253_14_239_9¶
SCS_1030¶
ADQ¶
1¶
| Instance id: | LA3_LAS_PPL/ADQ/1 |
|---|---|
| Class id: | AdqDigitizer |
| Host: | la3-las-sys-utc-1 |
| Class documentation: | |
| AdqDigitizer | |
| Alias: | la3-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: | ADQ1RAW, 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, 19:39: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’])!
The AdqDigitizer device is documented in
adqdigitizer:welcome
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The 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
| Created: | 2021-05-11T12:48:09.000+02:00 |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Avoid concurrent writes to the output channel |
| Created: | 2021-04-28T22:44:21.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: | Fix board configurations |
| 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. |
| 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. |
| Created: | 2020-11-30T10:43:54.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| 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 |
| Created: | 2020-09-07T14:05:12.000+02:00 |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added “None” option for trigger output |
| 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 |
| Created: | 2020-08-12T16:10:52.000+02:00 |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Similar fix for older digitizer firmware version |
| 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 |
| 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. |
| Created: | 2020-07-29T14:35:44.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| 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,… |
| 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. |
| 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. |
| 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. |
| 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 |
| Created: | 2019-03-05T16:54:26.000+01:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: | Bug fixing release: misinterpreted index, recovery trigger settings after the crash. |
| Created: | 2019-02-25T14:17:36.000+01:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: | Fix race condition and SEGFAULT. |
| 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: | LA3_DAQ_DATA/DA/1 |
|---|---|
| Class id: | DataAggregator |
| Host: | la3-br-sys-daq-srv1 |
| Alias: | la3-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: | LA3_RUN_CONTROL_1-OBSOLETE |
| Accessible by: |
Warning
Host not accessible by [‘xctrl’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether 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
| Created: | 2021-09-28T14:01:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-09-24T08:56:29.000+00:00 |
|---|---|
| Author: | Geogin Varghese |
| Notes: | pclayer release candidate 1 for Karabo 2.11 support |
| Created: | 2021-07-05T16:34:28.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release PC Layer 1.10.4-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 |
| 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 |
| Created: | 2021-06-24T01:21:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc1 |
| Created: | 2021-06-21T01:03:13.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc0 |
| Created: | 2021-06-14T07:48:22.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra4 |
| Created: | 2021-06-09T23:44:24.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra3 |
| Created: | 2021-06-09T16:22:33.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-09T14:53:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-03T18:06:16.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-06-02T12:39:31.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test tag 1.10.2-2.10.0-rx4 |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release of PC layer 1.10.2-2.10.0 |
| Created: | 2021-05-26T08:29:43.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx3 |
| Created: | 2021-05-25T18:06:03.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx2 |
| Created: | 2021-05-14T10:36:11.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx1 |
| 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. |
| Created: | 2021-04-30T02:26:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
2¶
| Instance id: | LA3_DAQ_DATA/DA/2 |
|---|---|
| Class id: | DataAggregator |
| Host: | la3-br-sys-daq-srv1 |
| Alias: | la3-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: | LA3_RUN_CONTROL_1-OBSOLETE |
| Accessible by: |
Warning
Host not accessible by [‘xctrl’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether 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
| Created: | 2021-09-28T14:01:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-09-24T08:56:29.000+00:00 |
|---|---|
| Author: | Geogin Varghese |
| Notes: | pclayer release candidate 1 for Karabo 2.11 support |
| Created: | 2021-07-05T16:34:28.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release PC Layer 1.10.4-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 |
| 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 |
| Created: | 2021-06-24T01:21:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc1 |
| Created: | 2021-06-21T01:03:13.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc0 |
| Created: | 2021-06-14T07:48:22.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra4 |
| Created: | 2021-06-09T23:44:24.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra3 |
| Created: | 2021-06-09T16:22:33.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-09T14:53:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-03T18:06:16.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-06-02T12:39:31.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test tag 1.10.2-2.10.0-rx4 |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release of PC layer 1.10.2-2.10.0 |
| Created: | 2021-05-26T08:29:43.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx3 |
| Created: | 2021-05-25T18:06:03.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx2 |
| Created: | 2021-05-14T10:36:11.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx1 |
| 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. |
| Created: | 2021-04-30T02:26:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
DM¶
CONFIGURATOR_1¶
| Instance id: | LA3_DAQ_DATA/DM/CONFIGURATOR_1 |
|---|---|
| Class id: | RunConfigurator |
| Host: | la3-br-sys-daq-srv1 |
| Alias: | la3-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: | LA3_RUN_CONTROL_1-OBSOLETE, LA3_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, LA3_RUN_CONTROL_GLOBAL_STATE |
| Accessible by: |
Warning
Host not accessible by [‘xctrl’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
DATA_MANAGER_1¶
| Instance id: | LA3_DAQ_DATA/DM/DATA_MANAGER_1 |
|---|---|
| Class id: | DataManager |
| Host: | la3-br-sys-daq-srv1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether 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
| Created: | 2021-09-28T14:01:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-09-24T08:56:29.000+00:00 |
|---|---|
| Author: | Geogin Varghese |
| Notes: | pclayer release candidate 1 for Karabo 2.11 support |
| Created: | 2021-07-05T16:34:28.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release PC Layer 1.10.4-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 |
| 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 |
| Created: | 2021-06-24T01:21:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc1 |
| Created: | 2021-06-21T01:03:13.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc0 |
| Created: | 2021-06-14T07:48:22.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra4 |
| Created: | 2021-06-09T23:44:24.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra3 |
| Created: | 2021-06-09T16:22:33.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-09T14:53:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-03T18:06:16.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-06-02T12:39:31.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test tag 1.10.2-2.10.0-rx4 |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release of PC layer 1.10.2-2.10.0 |
| Created: | 2021-05-26T08:29:43.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx3 |
| Created: | 2021-05-25T18:06:03.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx2 |
| Created: | 2021-05-14T10:36:11.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx1 |
| 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. |
| Created: | 2021-04-30T02:26:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
DSG_CHECK_1¶
| Instance id: | LA3_DAQ_DATA/DM/DSG_CHECK_1 |
|---|---|
| Class id: | CheckConfigGroups |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
- The heartbeat interval
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
- This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
- Configures who is allowed to see this device at all
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server
- pid:
- The unix process ID of the device (i.e. of the server)
- state:
- The current state the device is in
- status:
- A more detailed status description
- lockedBy:
- The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
- Clear the lock 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
| Created: | 2021-07-08T18:01:02.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-28T21:45:57.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-09T14:34:36.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-09T14:34:36.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-03T17:02:14.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| 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 |
| Created: | 2019-04-17T17:54:16.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.8.1-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. |
| Created: | 2019-01-31T17:58:06.000+01:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: | Release tag 2.0.8-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! |
| Created: | 2019-01-28T16:23:50.000+01:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: | This tag includes bugs fix. |
| Created: | 2019-01-25T10:40:18.000+01:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
|
| Created: | 2018-10-22T15:51:35.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.4 |
| Created: | 2018-05-03T14:55:29.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.3-2.2.3 |
| Created: | 2018-04-25T01:22:08.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.2-2.2.3 |
| Created: | 2018-04-23T23:00:46.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.1-2.2.3 |
| Created: | 2018-04-18T16:17:44.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.0-2.2.3 |
| Created: | 2018-03-29T11:43:32.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2018-03-29T11:36:38.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2018-03-29T11:31:23.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
DSG_REPORT_1¶
| Instance id: | LA3_DAQ_DATA/DM/DSG_REPORT_1 |
|---|---|
| Class id: | ReportConfigGroups |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
- The heartbeat interval
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
- This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
- Configures who is allowed to see this device at all
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server
- pid:
- The unix process ID of the device (i.e. of the server)
- state:
- The current state the device is in
- status:
- A more detailed status description
- lockedBy:
- The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
- Clear the lock 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
| Created: | 2021-07-08T18:01:02.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-28T21:45:57.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-09T14:34:36.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-09T14:34:36.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| Created: | 2021-06-03T17:02:14.000+02:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: |
| 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 |
| Created: | 2019-04-17T17:54:16.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.8.1-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. |
| Created: | 2019-01-31T17:58:06.000+01:00 |
|---|---|
| Author: | Parthasarathy Tirumalai |
| Notes: | Release tag 2.0.8-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! |
| Created: | 2019-01-28T16:23:50.000+01:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: | This tag includes bugs fix. |
| Created: | 2019-01-25T10:40:18.000+01:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
|
| Created: | 2018-10-22T15:51:35.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.4 |
| Created: | 2018-05-03T14:55:29.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.3-2.2.3 |
| Created: | 2018-04-25T01:22:08.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.2-2.2.3 |
| Created: | 2018-04-23T23:00:46.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.1-2.2.3 |
| Created: | 2018-04-18T16:17:44.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.0-2.2.3 |
| Created: | 2018-03-29T11:43:32.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2018-03-29T11:36:38.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2018-03-29T11:31:23.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
MDC_REMOTE_1¶
| Instance id: | LA3_DAQ_DATA/DM/MDC_REMOTE_1 |
|---|---|
| Class id: | MetadataDBRemote |
| Host: | la3-br-sys-daq-srv1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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
| Created: | 2021-06-23T14:55:12.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.3.0-2.11.1 |
| Created: | 2021-06-18T14:42:04.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.2.2-2.11.1 |
| Created: | 2021-06-04T15:22:01.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.2.2-2.10.5 |
| Created: | 2021-06-03T17:17:57.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.2.1-2.10.5.rc1 |
| Created: | 2021-06-03T03:39:27.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.2.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 |
| Created: | 2021-06-02T12:57:58.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2020-06-30T22:51:41.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.0.7-2.9.2 |
| Created: | 2020-06-11T10:48:57.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.0.6-2.9.1_rc1 |
| Created: | 2020-01-27T12:14:04.000+01:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 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.7.0 |
| Created: | 2019-08-23T08:12:16.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.0.3-2.6.1 |
| Created: | 2019-08-23T00:53:46.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.0.3-2.5.1 |
| Created: | 2019-08-16T15:26:20.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 3.0.0-2.5.1 |
| Created: | 2017-12-21T15:52:41.000+01:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 2.0.0-2.2.0 |
| Created: | 2017-12-21T09:32:55.000+01:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 1.1.6-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 |
| Created: | 2017-11-10T14:19:21.000+01:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 1.1.4-2.1.16 |
| Created: | 2017-09-13T20:17:46.000+02:00 |
|---|---|
| Author: | Luis Maia |
| Notes: | Release tag 1.1.2-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: | LA3_DAQ_DATA/DM/RUN_CONTROL_1 |
|---|---|
| Class id: | RunController |
| Host: | la3-br-sys-daq-srv1 |
| Alias: | la3-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: | LA3_RUN_CONTROL_1-OBSOLETE, LA3_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, LA3_RUN_CONTROL_GLOBAL_STATE |
| Accessible by: |
Warning
Host not accessible by [‘xctrl’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether 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
| Created: | 2021-09-28T14:01:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-09-24T08:56:29.000+00:00 |
|---|---|
| Author: | Geogin Varghese |
| Notes: | pclayer release candidate 1 for Karabo 2.11 support |
| Created: | 2021-07-05T16:34:28.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release PC Layer 1.10.4-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 |
| 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 |
| Created: | 2021-06-24T01:21:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc1 |
| Created: | 2021-06-21T01:03:13.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc0 |
| Created: | 2021-06-14T07:48:22.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra4 |
| Created: | 2021-06-09T23:44:24.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra3 |
| Created: | 2021-06-09T16:22:33.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-09T14:53:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-03T18:06:16.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-06-02T12:39:31.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test tag 1.10.2-2.10.0-rx4 |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release of PC layer 1.10.2-2.10.0 |
| Created: | 2021-05-26T08:29:43.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx3 |
| Created: | 2021-05-25T18:06:03.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx2 |
| Created: | 2021-05-14T10:36:11.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx1 |
| 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. |
| Created: | 2021-04-30T02:26:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
LA3_BCC_STAGE_POS_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LA3_BCC_STAGE_POS_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | exflcon94n0 |
| Alias: | sa3-br-sys-daq-dsg1Ê , sqs-br-sys-daq-dsg1Ê , scs-br-sys-daq-dsg1Ê |
| Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework |
| Last modified: | 2020-11-21T11:08:53.000+01:00 |
| Created at: | 2016-02-25T15:17:38.000+01:00 |
| Main authors: | Carinan, Danilevski, Mamchykd |
| Latest tag: | 2.10.0rc6 |
| Deployment tag: | 2.10.0rc6 |
| Accessible by: |
Warning
Host not accessible by [‘xctrl’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2020-11-16T16:48:09.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: | 6-th Release Candidate for 2.10 |
| Created: | 2020-11-16T16:48:09.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: | Karabo version 2.10.0 The most relevant improvements, fixes and changes are: Core Functionality: A ConfigurationManager has been added to the framework, offering a new way to manage device configurations (Minimum Viable Product state) GUI: - The Karabo GUI is shipped now with open license fonts to ensure
Input-/OutputChannel Pipelines: - All APIs: The available options of the onSlowness parameter that
MDL: - Every requiredAccessLevel which will be at least AccessLevel.USER for
C++ API - C++/bound: The legacy point-to-point shortcut for broker type communication has been removed.
See https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.10.html for more details. |
| Created: | 2020-11-13T10:35:39.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | 5th RC for 2.10.0 |
| Created: | 2020-11-11T18:10:00.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: | 4-th release candidate of 2.10.0 |
| Created: | 2020-11-10T16:48:35.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | 3rd release candidate of 2.10 |
| Created: | 2020-11-06T16:41:13.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | 2nd release candidate of 2.10 |
| Created: | 2020-11-04T17:01:01.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First release candidate of 2.10.0 |
| Created: | 2020-11-04T10:38:01.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: |
| Created: | 2020-10-30T15:10:56.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2020-10-28T14:50:56.000Z |
|---|---|
| Author: | Raul Costa |
| Notes: |
| Created: | 2020-10-27T18:34:03.000Z |
|---|---|
| Author: | Raul Costa |
| Notes: |
| Created: | 2020-10-27T18:34:03.000Z |
|---|---|
| Author: | Raul Costa |
| Notes: |
| Created: | 2020-10-23T13:45:17.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | weekly release |
| Created: | 2020-10-16T23:58:16.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2020-10-16T16:16:08.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: |
| Created: | 2020-10-09T13:52:57.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2020-10-02T08:18:40.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | Weekly release |
| Created: | 2020-09-29T19:41:22.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Adding CentOS8 to the builds |
| Created: | 2020-09-29T06:13:38.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Weekly release |
| Created: | 2020-09-28T15:38:31.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
LA3_ENV_MON_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LA3_ENV_MON_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | exflcon94n0 |
| Alias: | sa3-br-sys-daq-dsg1Ê , sqs-br-sys-daq-dsg1Ê , scs-br-sys-daq-dsg1Ê |
| Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework |
| Last modified: | 2020-11-21T11:08:53.000+01:00 |
| Created at: | 2016-02-25T15:17:38.000+01:00 |
| Main authors: | Carinan, Danilevski, Mamchykd |
| Latest tag: | 2.10.0rc6 |
| Deployment tag: | 2.10.0rc6 |
| Accessible by: |
Warning
Host not accessible by [‘xctrl’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2020-11-16T16:48:09.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: | 6-th Release Candidate for 2.10 |
| Created: | 2020-11-16T16:48:09.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: | Karabo version 2.10.0 The most relevant improvements, fixes and changes are: Core Functionality: A ConfigurationManager has been added to the framework, offering a new way to manage device configurations (Minimum Viable Product state) GUI: - The Karabo GUI is shipped now with open license fonts to ensure
Input-/OutputChannel Pipelines: - All APIs: The available options of the onSlowness parameter that
MDL: - Every requiredAccessLevel which will be at least AccessLevel.USER for
C++ API - C++/bound: The legacy point-to-point shortcut for broker type communication has been removed.
See https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.10.html for more details. |
| Created: | 2020-11-13T10:35:39.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | 5th RC for 2.10.0 |
| Created: | 2020-11-11T18:10:00.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: | 4-th release candidate of 2.10.0 |
| Created: | 2020-11-10T16:48:35.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | 3rd release candidate of 2.10 |
| Created: | 2020-11-06T16:41:13.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | 2nd release candidate of 2.10 |
| Created: | 2020-11-04T17:01:01.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First release candidate of 2.10.0 |
| Created: | 2020-11-04T10:38:01.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: |
| Created: | 2020-10-30T15:10:56.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2020-10-28T14:50:56.000Z |
|---|---|
| Author: | Raul Costa |
| Notes: |
| Created: | 2020-10-27T18:34:03.000Z |
|---|---|
| Author: | Raul Costa |
| Notes: |
| Created: | 2020-10-27T18:34:03.000Z |
|---|---|
| Author: | Raul Costa |
| Notes: |
| Created: | 2020-10-23T13:45:17.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | weekly release |
| Created: | 2020-10-16T23:58:16.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2020-10-16T16:16:08.000Z |
|---|---|
| Author: | Cammille Carinan |
| Notes: |
| Created: | 2020-10-09T13:52:57.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2020-10-02T08:18:40.000Z |
|---|---|
| Author: | Dennis Goeries |
| Notes: | Weekly release |
| Created: | 2020-09-29T19:41:22.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Adding CentOS8 to the builds |
| Created: | 2020-09-29T06:13:38.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Weekly release |
| Created: | 2020-09-28T15:38:31.000Z |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
LA3_PLC_COMPSTAGE_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LA3_PLC_COMPSTAGE_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LA3_PLC_ENV_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LA3_PLC_ENV_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_20HZ_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_20HZ_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_DIAG1_TEST_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_DIAG1_TEST_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_DIAG_BECKHOFF_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_DIAG_BECKHOFF_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_DIAG_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_DIAG_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_FADC_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_FADC_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_PROC_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_PROC_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_SCS_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_SCS_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_SPECT_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_SPECT_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_SQS_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_SQS_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LAS_TEMP_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LAS_TEMP_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
LA3_DOC_ADHOC_GROUP¶
| Instance id: | LA3_DAQ_DATA/DM/LA3_DOC_ADHOC_GROUP |
|---|---|
| Class id: | RunConfigurationGroup |
| Host: | la3-br-sys-daq-dsg1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
- The progress of the current action
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- Logger:
- Logging settings
- group:
- Structure describing data sources logically belonging together.
- owner:
- The person to contact regarding usage of this group
| Created: | 2021-09-29T14:00:53.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | 2nd release candidate of 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. |
| Created: | 2021-09-27T15:58:05.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | 1st release candidate of 2.12.0 |
| Created: | 2021-09-15T14:44:02.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-09-15T08:51:47.000+02:00 |
|---|---|
| Author: | Raul Costa |
| Notes: | Update the redis client |
| Created: | 2021-08-24T11:16:33.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-23T11:54:12.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-13T18:29:03.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-08-13T11:40:40.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-08-06T15:19:37.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-21T17:31:29.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | First rc of 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 |
| Created: | 2021-07-09T12:42:52.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-07-09T12:13:14.000+02:00 |
|---|---|
| Author: | Sergey Esenov |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Same as 2.12.0a3 |
| Created: | 2021-07-07T13:49:07.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: | Experimental branch with many brokers |
| Created: | 2021-06-29T14:30:20.000+02:00 |
|---|---|
| Author: | Gero Flucke |
| Notes: |
| Created: | 2021-06-23T17:14:20.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
| Created: | 2021-06-22T19:53:47.000+02:00 |
|---|---|
| Author: | Dennis Goeries |
| Notes: |
DOC¶
1¶
| Instance id: | LA3_DAQ_DATA/DOC/1 |
|---|---|
| Class id: | DataAggregator |
| Host: | la3-br-sys-daq-srv1 |
| Alias: | la3-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’]!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether 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
| Created: | 2021-09-28T14:01:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-09-24T08:56:29.000+00:00 |
|---|---|
| Author: | Geogin Varghese |
| Notes: | pclayer release candidate 1 for Karabo 2.11 support |
| Created: | 2021-07-05T16:34:28.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release PC Layer 1.10.4-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 |
| 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 |
| Created: | 2021-06-24T01:21:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc1 |
| Created: | 2021-06-21T01:03:13.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release candidate 1.10.3-2.10.5-rc0 |
| Created: | 2021-06-14T07:48:22.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra4 |
| Created: | 2021-06-09T23:44:24.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.3-2.10.5-ra3 |
| Created: | 2021-06-09T16:22:33.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-09T14:53:52.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
| Created: | 2021-06-03T18:06:16.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-06-02T12:39:31.000+02:00 |
|---|---|
| Author: | Nasser Al-Qudami |
| Notes: |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test tag 1.10.2-2.10.0-rx4 |
| Created: | 2021-05-26T14:25:23.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Release of PC layer 1.10.2-2.10.0 |
| Created: | 2021-05-26T08:29:43.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx3 |
| Created: | 2021-05-25T18:06:03.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx2 |
| Created: | 2021-05-14T10:36:11.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: | Test release 1.10.2-2.10.0-rx1 |
| 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. |
| Created: | 2021-04-30T02:26:16.000+02:00 |
|---|---|
| Author: | Djelloul Boukhelef |
| Notes: |
CTRL¶
SCS¶
ILH¶
LAS¶
PROC¶
8CAM1¶
| Instance id: | SCS_ILH_LAS/PROC/8CAM1 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SCS_NOPA_BEAM_POS_ALL, SCS_NOPA_BEAM_POS |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
CAM¶
LAS¶
PPL¶
SA3XT¶
ACTRL¶
AO_1¶
| Instance id: | LAS_PPL_SA3XT/ACTRL/AO_1 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ACTRL/AO_2 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ACTRL/AO_3 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ACTRL/AO_4 |
|---|---|
| Class id: | BeckhoffAnalogOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogOutput device is documented in
beckhoff:BeckhoffAnalogOutput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not 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!
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ASENS/AI_1 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ASENS/AI_2 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ASENS/AI_3 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ASENS/AI_4 |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ASENS/HYGROMETER_SPARE_SIG |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/ASENS/HYGROMETER_SPARE_TEMP |
|---|---|
| Class id: | BeckhoffAnalogInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffAnalogInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffAnalogInput device is documented in
beckhoff:BeckhoffAnalogInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- value:
- Analog input of ADC.
- semiRawValue:
- Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
- Epsilon of the SemiRawValue.
- relativeEpsilon:
- Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/DCTRL/24V_OUTPUT_1 |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/DCTRL/24V_OUTPUT_2 |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/DCTRL/5V_OUTPUT_1 |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/DCTRL/5V_OUTPUT_2 |
|---|---|
| Class id: | BeckhoffDigitalOutput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalOutput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- on:
- Instructs the device to switch on
- off:
- Instructs device to switch off
- pwmCycleLimit:
- Number Of PWM Cycles, 0 = inifite number of cycles
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/MOTOR/LINSTAGE_SPARE_1 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/MOTOR/LINSTAGE_SPARE_2 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/MOTOR/LINSTAGE_SPARE_3 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/MOTOR/LINSTAGE_SPARE_4 |
|---|---|
| Class id: | BeckhoffSimpleMotor |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffSimpleMotor | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
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.
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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.
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/MOTOR/SMARACTCMCOMPSTAGE |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | RF-Signal |
| 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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/MOTOR/SMARACTDMCOMPSTAGE |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | SCSdmRFSignal, SQSdmRFSignal |
| 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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SMARACTSPARE1¶
| Instance id: | LAS_PPL_SA3XT/MOTOR/SMARACTSPARE1 |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SMARACTSPARE2¶
| Instance id: | LAS_PPL_SA3XT/MOTOR/SMARACTSPARE2 |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SMARACTTRACYCOMP_SCS_1¶
| Instance id: | LAS_PPL_SA3XT/MOTOR/SMARACTTRACYCOMP_SCS_1 |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | TreacyComSCS |
| 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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SMARACTTRACYCOMP_SCS_2¶
| Instance id: | LAS_PPL_SA3XT/MOTOR/SMARACTTRACYCOMP_SCS_2 |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-2.11.1 |
| Scenes: | TreacyComSCS |
| 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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SMARACTTRACYCOMP_SQS_1¶
| Instance id: | LAS_PPL_SA3XT/MOTOR/SMARACTTRACYCOMP_SQS_1 |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SMARACTTRACYCOMP_SQS_2¶
| Instance id: | LAS_PPL_SA3XT/MOTOR/SMARACTTRACYCOMP_SQS_2 |
|---|---|
| Class id: | BeckhoffMC2Base |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffMC2Base | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-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!
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:
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/SWITCH/DI_1 |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/SWITCH/DI_2 |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/SWITCH/DI_3 |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/SWITCH/DI_4 |
|---|---|
| Class id: | BeckhoffDigitalInput |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffDigitalInput | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
The BeckhoffDigitalInput device is documented in
beckhoff:BeckhoffDigitalInput
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
- set to limit maximum update frequency for some values.
- invert:
- If set, the digital value as received from the hardware is inverted.
- edgeCount:
- Counter of the input edges
- fallingEdgeCounter:
- True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
- Reset count of edges
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/VALVE/PUMPLINE |
|---|---|
| Class id: | BeckhoffValve |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffValve | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| 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_SA3XT/VALVE/SPARE |
|---|---|
| Class id: | BeckhoffValve |
| Host: | la3-rr-ppl-con-1 |
| Class documentation: | |
| BeckhoffValve | |
| General: | link |
| Monitor: | link |
| Developer: | link |
| PLC: | link |
| Alias: | la3-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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device (i.e. of the server
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- heartbeatInterval:
- The heartbeat interval
- performanceStatistics:
- Accumulates some statistics
- beckhoffComDevice:
- InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
- The type of the firmware block.
- fwInstanceName:
- The name of the firmware block instance.
- fwVersion:
- The version of the PLC framework.
- terminal:
- ???
- hardwareStatusBitField:
- This word encodes in bits the hardware-status information of this device
- hardwareState:
- The current state of the hardware decoded
- hardwareRegion:
- The current region of the hardware decoded
- hardwareErrorDescriptor:
- This word encodes in bits describing the hardware error
- hardwareErrorDescription:
- Error Code description
- waitingFor:
- Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
- The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
- Defines whether interlock conditions are configurable from this interface.
- interlockOn:
- Defines whether interlock surveillance is on or off.
- interlockOk:
- Defines whether interlock is ok (true) or broken (false).
- busy:
- Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
- If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
- If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
- Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
- State update rate is above ‘Max State Update Rate’ threshold.
- reset:
- Resets the PLC hardware
- enableInterlockedSlots:
- Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
- Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
- Ask for all property values on the device
- propertiesToPoll:
- All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
- Hardware poll interval in seconds
- propertiesToRead:
- The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
- Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
- ???
- trigger:
- 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
| Created: | 2021-10-02T07:28:37.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Release candidate for 4.8.2 |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-09-13T18:14:58.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-08-23T15:36:04.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state |
| Created: | 2021-08-12T10:32:15.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits |
| Created: | 2021-07-28T14:22:45.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
| Created: | 2021-06-23T16:13:27.000+02:00 |
|---|---|
| Author: | xctrl |
| Notes: |
| Created: | 2021-06-22T13:56:55.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: |
|
| Created: | 2021-06-14T16:09:11.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Added BeckhoffDryPump |
| Created: | 2021-06-10T11:55:43.000+02:00 |
|---|---|
| Author: | Alessandro Silenzi |
| Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment) |
| Created: | 2021-06-07T19:31:48.000+02:00 |
|---|---|
| Author: | Valerii Bondar |
| Notes: | Summer shutdown release, Fuse device added |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-06-02T14:39:34.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes |
| Created: | 2021-05-31T09:49:13.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-26T14:46:29.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-23T08:19:59.000+02:00 |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2021-04-23T07:43:58.000+02:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: |
| Created: | 2021-04-15T18:15:29.000+02:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: |
| Created: | 2021-03-24T09:43:30.000+01:00 |
|---|---|
| Author: | Steffen Hauf |
| Notes: | Add the AIBS |
| Created: | 2021-03-08T09:52:30.000+01:00 |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400 |
SQS¶
ILH¶
LAS¶
PROC¶
BS_CAM_800_OU1¶
| Instance id: | SQS_ILH_LAS/PROC/BS_CAM_800_OU1 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SQS_NOPA_BEAM_POS_ALL, SQS_NOPA_BEAM_POS |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
BS_CAM_800_OU2¶
| Instance id: | SQS_ILH_LAS/PROC/BS_CAM_800_OU2 |
|---|---|
| Class id: | ImageProcessor |
| Host: | exflcon225 |
| Class documentation: | |
| ImageProcessor | |
| Alias: | la3-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: | SQS_NOPA_BEAM_POS_ALL, SQS_NOPA_BEAM_POS |
| Accessible by: | |
Warning
Host not accessible by [‘xctrl’]!
The ImageProcessor device is documented in
imageprocessor:image-processor-user
- visibility:
- Configures who is allowed to see this device at all
- deviceId:
- The device instance ID uniquely identifies a device instance in the distributed system
- classId:
- The (factory)-name of the class of this device
- classVersion:
- The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
- The version of the Karabo framework running this device
- serverId:
- The device-server on which this device is running on
- hostName:
- Do not set this property, it will be set by the device-server.
- pid:
- The unix process ID of the device
- state:
- The current state the device is in
- status:
- A more detailed status description
- alarmCondition:
- The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
- The last slot called.
- archive:
- Decides whether the properties of this device will be logged or not
- useTimeserver:
- Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
- The instance id uniquely identifies a 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.
| Created: | 2020-11-23T11:51:09.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: | Karabo 2.10 versioning |
| Created: | 2020-07-30T12:29:13.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Reset properties only once |
| Created: | 2020-07-28T12:08:55.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction |
| Created: | 2020-07-06T11:53:30.000Z |
|---|---|
| Author: | Riccardo Fabbri |
| Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set |
| Created: | 2020-03-17T10:23:50.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Fix MDL’s error count reconfiguration + resetError function |
| 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 |
| Created: | 2019-12-10T13:13:22.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6 |
| Created: | 2019-09-25T07:12:39.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | ImageToSpectrum: make direction of integral configurable. |
| Created: | 2019-09-17T15:59:16.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Added peak ratio for TwoPeakFinder device. |
| Created: | 2019-09-05T15:06:43.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Implemented thresholding for integrated data intensities. |
| Created: | 2019-09-04T12:46:06.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX 1D data ImageAverager |
| Created: | 2019-08-22T14:57:59.000Z |
|---|---|
| Author: | Cyril Danilevski |
| Notes: | Add possibility to average spectra (1D images) |
| Created: | 2019-07-10T07:31:19.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | FIX processing of spectra |
| Created: | 2019-07-05T14:19:56.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
| Created: | 2019-07-01T08:20:28.000Z |
|---|---|
| Author: | Gabriele Giovanetti |
| Notes: |
|
| Created: | 2019-06-18T11:41:45.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Add possibility to process spectra (1D images) |
| Created: | 2019-05-09T14:59:33.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: | Adding option for lightweight exponential running average |
| Created: | 2019-04-30T12:34:21.000Z |
|---|---|
| Author: | Robert Schaffer |
| Notes: | Fixed a bug causing thresholding downstream of COM calculation |
| Created: | 2019-03-26T17:58:39.000Z |
|---|---|
| Author: | Wajid Ehsan |
| Notes: | Include roi in y-direction imageTospectrum |
| Created: | 2019-02-21T09:22:07.000Z |
|---|---|
| Author: | Andrea Parenti |
| Notes: |
|
Non-standard installations¶
Host could not be accessed
| Affected classes: | |
|---|---|
| DataAggregator, RunConfigurator, DataManager, MetadataDBRemote, RunController | |
| Affected devices: | |
| LA3_DAQ_DATA/DA/1, LA3_DAQ_DATA/DA/2, LA3_DAQ_DATA/DOC/1, LA3_DAQ_DATA/DM/CONFIGURATOR_1, LA3_DAQ_DATA/DM/DATA_MANAGER_1, LA3_DAQ_DATA/DM/MDC_REMOTE_1, LA3_DAQ_DATA/DM/RUN_CONTROL_1 | |
Host could not be accessed
| Affected classes: | |
|---|---|
RunConfigurationGroup, CheckConfigGroups, ReportConfigGroups |
|
| Affected devices: | |
LA3_DAQ_DATA/DM/BCC_STAGE_POS_GROUP, LA3_DAQ_DATA/DM/ENV_MON_GROUP, LA3_DAQ_DATA/DM/LA3_DOC_ADHOC_GROUP, LA3_DAQ_DATA/DM/LA3_PLC_COMPSTAGE_GROUP, LA3_DAQ_DATA/DM/LA3_PLC_ENV_GROUP, LA3_DAQ_DATA/DM/LAS_20HZ_GROUP, LA3_DAQ_DATA/DM/LAS_DIAG1_TEST_GROUP, LA3_DAQ_DATA/DM/LAS_DIAG_BECKHOFF_GROUP, LA3_DAQ_DATA/DM/LAS_DIAG_GROUP, LA3_DAQ_DATA/DM/LAS_FADC_GROUP, LA3_DAQ_DATA/DM/LAS_PROC_GROUP, LA3_DAQ_DATA/DM/LAS_SCS_GROUP, LA3_DAQ_DATA/DM/LAS_SPECT_GROUP, LA3_DAQ_DATA/DM/LAS_SQS_GROUP, LA3_DAQ_DATA/DM/LAS_TEMP_GROUP, LA3_DAQ_DATA/DM/DSG_CHECK_1, LA3_DAQ_DATA/DM/DSG_REPORT_1 |
|
| BeckhoffAnalogInput: | |
|
|
| BeckhoffAnalogOutput: | |
|
|
| BeckhoffDigitalOutput: | |
|
|
| BeckhoffEncoder: | |
|
|
| BeckhoffMonitor: | |
|
|
| BeckhoffSimpleMotor: | |
|
|
| BeckhoffCom: |
|
| BeckhoffPlcMonitor: | |
|
|
| BeckhoffDigitalInput: | |
|
|
| BeckhoffValve: |
|
| BeckhoffMC2Base: | |
|
|
| AdqDigitizer: |
|
| AutoCorrelator: |
|
| AutoCorrelator: |
|
Non-standard deployments¶
la3-rr-ppl-con-1¶
- Rogue install for BeckhoffAnalogInput: 4.6.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffAnalogOutput: 4.6.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalOutput: 4.6.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffEncoder: 4.6.4-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.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffCom: 4.6.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffPlcMonitor: 4.6.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffDigitalInput: 4.6.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffValve: 4.6.4-2.11.1 installed but not in deployment.
- Rogue install for BeckhoffMC2Base: 4.6.4-2.11.1 installed but not in deployment.
la3-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.
la3-rr-ppl-con-2¶
- Rogue install for AutoCorrelator: 2.3.6-2.10.0 installed but not in deployment.
la3-rr-ppl-con-3¶
- Rogue install for AutoCorrelator: 2.3.6-2.10.0 installed but not in deployment.
Non-standard instance ids¶
- KaraboGuiErrorLogger
Problematic Interface Configs¶
Non-reachable devices¶
These devices are not included in any project or scene
- LA3_DAQ_DATA/DM/BCC_STAGE_POS_GROUP
- LA3_DAQ_DATA/DM/ENV_MON_GROUP
- LA3_DAQ_DATA/DM/LA3_DOC_ADHOC_GROUP
- LA3_DAQ_DATA/DM/LA3_PLC_COMPSTAGE_GROUP
- LA3_DAQ_DATA/DM/LA3_PLC_ENV_GROUP
- LA3_DAQ_DATA/DM/LAS_20HZ_GROUP
- LA3_DAQ_DATA/DM/LAS_DIAG1_TEST_GROUP
- LA3_DAQ_DATA/DM/LAS_DIAG_BECKHOFF_GROUP
- LA3_DAQ_DATA/DM/LAS_DIAG_GROUP
- LA3_DAQ_DATA/DM/LAS_FADC_GROUP
- LA3_DAQ_DATA/DM/LAS_PROC_GROUP
- LA3_DAQ_DATA/DM/LAS_SCS_GROUP
- LA3_DAQ_DATA/DM/LAS_SPECT_GROUP
- LA3_DAQ_DATA/DM/LAS_SQS_GROUP
- LA3_DAQ_DATA/DM/LAS_TEMP_GROUP
- LA3_DAQ_DATA/DM/DATA_MANAGER_1
- LA3_DAQ_DATA/DM/MDC_REMOTE_1
- LA3_DAQ_DATA/DOC/1
- LA3_LAS_PPL/ACTRL/GUIDELASER_SCS_CTL_OUT
- LA3_LAS_PPL/ACTRL/GUIDELASER_SQS_CTL_OUT
- LA3_LAS_PPL/ACTRL/INPUT1
- LA3_LAS_PPL/ACTRL/INPUT2
- LA3_LAS_PPL/ACTRL/INPUT3
- LA3_LAS_PPL/ACTRL/INPUT4
- LA3_LAS_PPL/ACTRL/OUTPUT_1
- LA3_LAS_PPL/ACTRL/OUTPUT_2
- LA3_LAS_PPL/ACTRL/OUTPUT_3
- LA3_LAS_PPL/ACTRL/OUTPUT_4
- LA3_LAS_PPL/ASENS/GUIDELASER_SCS_MOD_IN
- LA3_LAS_PPL/ASENS/GUIDELASER_SQS_MOD_IN
- LA3_LAS_PPL/DCTRL/CHILLER_REMOTESTART
- LA3_LAS_PPL/ENC/DMCOMPSTAGE
- LA3_LAS_PPL/ENC/NANOSSPARE1
- LA3_LAS_PPL/ENC/TRACEYCOMP_SCS_1
- LA3_LAS_PPL/ENC/TRACEYCOMP_SCS_2
- LA3_LAS_PPL/ENC/TRACEYCOMP_SQS_1
- LA3_LAS_PPL/ENC/TRACEYCOMP_SQS_2
- LA3_LAS_PPL/MOTOR/CYLLENS_SCS_SA
- LA3_LAS_PPL/MOTOR/CYLLENS_SQS_SA
- LA3_LAS_PPL/MOTOR/CYL_LENS_STAGE_1
- LA3_LAS_PPL/MOTOR/CYL_LENS_STAGE_2
- LA3_LAS_PPL/PLC/COM
- LA3_LAS_PPL/PLC/COM_PLCMON
- LA3_LAS_PPL/PMOTOR/CMCOMPSTAGE_RESET
- LA3_LAS_PPL/PMOTOR/DMCOMPSTAGE_RESET
- LA3_LAS_PPL/PMOTOR/NANOSSPARE1_RESET
- LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_1_RESET
- LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SCS_2_RESET
- LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_1_RESET
- LA3_LAS_PPL/PMOTOR/TRACEYCOMP_SQS_2_RESET
- LA3_LAS_PPL/PUMP/BEAMPIPES_ERROR
- LA3_LAS_PPL/SWITCH/CHILLER_COLLECTIVEALARM
- LA3_LAS_PPL/SWITCH/CHILLER_FLOWALARM
- LA3_LAS_PPL/SWITCH/CHILLER_GUIDEVALUEALARM
- LA3_LAS_PPL/SWITCH/CHILLER_PRESSUREALARM
- LA3_LAS_PPL/SWITCH/CHILLER_TEMPERATUREALARM
- LA3_LAS_PPL/SWITCH/CHILLER_WATERALARM
- LA3_LAS_PPL/SWITCH/TRIGGER_
- LA3_LAS_PPL/TSENS/EQUIP_1
- LA3_LAS_PPL/TSENS/EQUIP_2
- LA3_LAS_PPL/TSENS/EQUIP_3
- LA3_LAS_PPL/TSENS/EQUIP_4
- LA3_LAS_PPL/TSENS/EQUIP_5
- LA3_LAS_PPL/TSENS/EQUIP_6
- LA3_LAS_PPL/TSENS/EQUIP_7
- LA3_LAS_PPL/TSENS/EQUIP_8
- LA3_LAS_PPL/TSENS/TABLE_6
- LA3_LAS_PPL/TSENS/TABLE_8
- LA3_LAS_PPL/VALVE/PUMPLINE
- LA3_LAS_PPL/VALVE/SPARE
- LAS_PPL_SA3XT/ACTRL/AO_1
- LAS_PPL_SA3XT/ACTRL/AO_2
- LAS_PPL_SA3XT/ACTRL/AO_3
- LAS_PPL_SA3XT/ACTRL/AO_4
- LAS_PPL_SA3XT/ASENS/AI_1
- LAS_PPL_SA3XT/ASENS/AI_2
- LAS_PPL_SA3XT/ASENS/AI_3
- LAS_PPL_SA3XT/ASENS/AI_4
- LAS_PPL_SA3XT/ASENS/HYGROMETER_SPARE_SIG
- LAS_PPL_SA3XT/ASENS/HYGROMETER_SPARE_TEMP
- LAS_PPL_SA3XT/DCTRL/24V_OUTPUT_1
- LAS_PPL_SA3XT/DCTRL/24V_OUTPUT_2
- LAS_PPL_SA3XT/DCTRL/5V_OUTPUT_1
- LAS_PPL_SA3XT/DCTRL/5V_OUTPUT_2
- LAS_PPL_SA3XT/MOTOR/LINSTAGE_SPARE_1
- LAS_PPL_SA3XT/MOTOR/LINSTAGE_SPARE_2
- LAS_PPL_SA3XT/MOTOR/LINSTAGE_SPARE_3
- LAS_PPL_SA3XT/MOTOR/LINSTAGE_SPARE_4
- LAS_PPL_SA3XT/MOTOR/SMARACTSPARE1
- LAS_PPL_SA3XT/MOTOR/SMARACTSPARE2
- LAS_PPL_SA3XT/MOTOR/SMARACTTRACYCOMP_SQS_1
- LAS_PPL_SA3XT/MOTOR/SMARACTTRACYCOMP_SQS_2
- LAS_PPL_SA3XT/SWITCH/DI_1
- LAS_PPL_SA3XT/SWITCH/DI_2
- LAS_PPL_SA3XT/SWITCH/DI_3
- LAS_PPL_SA3XT/SWITCH/DI_4
- LAS_PPL_SA3XT/VALVE/PUMPLINE
- LAS_PPL_SA3XT/VALVE/SPARE
Access Rights Summary¶
| CAL: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3 |
|---|---|
| CONTROLS: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3, la3-las-sys-utc-1 |
| CTRL: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3, la3-las-sys-utc-1 |
| DA: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3 |
| WP78: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3 |
| brambrin: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3 |
| danilevc: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3 |
| kaned: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3, la3-las-sys-utc-1 |
| pallasf: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3 |
| xdoc: | la3-rr-ppl-con-2, la3-rr-ppl-con-1, la3-rr-ppl-con-3, la3-las-sys-utc-1 |
| babies: | la3-las-sys-utc-1 |
| cascella: | la3-las-sys-utc-1 |
| mramilli: | la3-las-sys-utc-1 |
| samartse: | la3-las-sys-utc-1 |
| tjezynsk: | la3-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¶
SQS user panel¶
| projects: | LA3_SQS_NOPA |
|---|
- LA3_LAS_PPL/CTRL/TRGDLY.MaxTsDelay
- LA3_LAS_PPL/CTRL/TRGDLY.activeExpPattern
- LA3_LAS_PPL/SPECT/NOPA_SQS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SQS_1.output.schema.data.spectrum
- LA3_LAS_PPL/PROC/NOPA_SQS_2.x01d,LA3_LAS_PPL/PROC/NOPA_SQS_2.y01d
- LA3_LAS_PPL/CTRL/TRGDLY.statusLaserPatternSource
- LA3_LAS_PPL/CTRL/TRGDLY.MidTsValue
- LA3_LAS_PPL/CTRL/TRGDLY.activeExpPatternApply
- LA3_LAS_PPL/CTRL/TRGDLY.delayTsChange
SQS BCC and spectrum¶
| projects: | LA3_SQS_NOPA |
|---|
- LA3_LAS_PPL/SPECT/NOPA_SQS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SQS_1.output.schema.data.spectrum
dmStageMotor¶
| projects: | LA3_DMBCCS |
|---|
- LA3_LAS_PPL/DCTRL/DMCOMPSTAGE.on
- LA3_LAS_PPL/DCTRL/DMCOMPSTAGE.off
LA3_LAS_PPL/CAM/AMPHOS_INPUT_NF|scene¶
| projects: | XF1 FE Diagnostic |
|---|
- LA3_LAS_PPL/CAM/AMPHOS_INPUT_NF.latencyTime
FE output NF cams¶
| projects: | FE output cams |
|---|
- LA3_LAS_PPL/CAM/FE_XF2_NF.connectCamera
- LA3_LAS_PPL/CAM/FE_XF1_NF.connectCamera
SCS 1030 Status Scene¶
| projects: | Instrument Timing and Status |
|---|
- LA3_LAS_PPL/PROC/SCS_UNCOMP.beamHeight1d,LA3_LAS_PPL/PROC/SCS_UNCOMP.beamWidth1d
- LA3_LAS_PPL/ASENS/EMETER_UNCOMP_SCS_OUT.measurement.pulse
- LA3_LAS_PPL/CAM/SCS_UNCOMP.output.schema.data.image
- LA3_LAS_PPL/PROC/SCS_UNCOMP.x01d,LA3_LAS_PPL/PROC/SCS_UNCOMP.y01d
FE CTRL¶
| projects: | LA3_FRONT_END |
|---|
- LA3_LAS_PPL/CAM/GALVO_DIAG.frameRate
- LA3_LAS_PPL/CTRL/ONEFIVE_FE.connect
- LA3_LAS_PPL/CAM/GALVO_DIAG.stop
- LA3_LAS_PPL/PROC/GALVO_DIAG.x0
- LA3_LAS_PPL/CAM/GALVO_DIAG.deviceId
- LA3_LAS_PPL/CAM/GALVO_DIAG.output.schema.data.image
- LA3_LAS_PPL/CAM/GALVO_DIAG.acquire
- LA3_LAS_PPL/PROC/GALVO_DIAG.y0
- LA3_LAS_PPL/CAM/GALVO_DIAG.connectCamera
SCS 1st stage¶
| projects: | LA3_SCS_NOPA |
|---|
- LA3_LAS_PPL/SPECT/NOPA_SCS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_1.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/NOPA_SCS_1.refSpectrum
- LA3_LAS_PPL/PROC/NOPA_SCS_1.x0,LA3_LAS_PPL/PROC/NOPA_SCS_1.y0
XF2 Near field¶
| projects: | FE output cams |
|---|
- LA3_LAS_PPL/CAM/FE_XF2_NF.connectCamera
- LA3_LAS_PPL/PROC/FE_XF2_NF.beamWidth1d,LA3_LAS_PPL/PROC/FE_XF2_NF.beamHeight1d
SCS 2nd stage¶
| projects: | LA3_SCS_NOPA |
|---|
- LA3_LAS_PPL/PROC/NOPA_SCS_2.x0,LA3_LAS_PPL/PROC/NOPA_SCS_2.y0
- LA3_LAS_PPL/SPECT/NOPA_SCS_2.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_2.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/NOPA_SCS_1.acquire,LA3_LAS_PPL/SPECT/NOPA_SCS_1.stop,LA3_LAS_PPL/SPECT/NOPA_SCS_2.refSpectrum
LA3_LAS_PPL/MDL/MULTI_PATTERN|Arbitrary SubPattern¶
| projects: | LA3_PPL_PATTERN |
|---|
- LA3_LAS_PPL/MDL/MULTI_PATTERN.userName
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.doocsPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.userPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternUserSequence
- LA3_LAS_PPL/MDL/MULTI_PATTERN.xfelBunchCharge,LA3_LAS_PPL/MDL/MULTI_PATTERN.doocsPplPattern,LA3_LAS_PPL/MDL/MULTI_PATTERN.userPplPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.applyUserConfigToDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternDoocsSequence
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.userPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.isMultiPatternAllowed
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.doocsPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternType
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.userPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.doocsPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternRepFactor
- LA3_LAS_PPL/MDL/MULTI_PATTERN.writeSequenceToDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.userLaserBit
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.userPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.readFromDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.userGroupName
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.doocsPplSubPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.writeToDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.baseFrequency
SCS status scene¶
| projects: | Instrument Timing and Status |
|---|
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.LP_SCSp
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.alive
- LA3_LAS_PPL/PROC/NOPA_SCS_2.x0,LA3_LAS_PPL/PROC/NOPA_SCS_2.y0
- LA3_LAS_PPL/SPECT/NOPA_SCS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_1.output.schema.data.spectrum
SQS status scene¶
| projects: | Instrument Timing and Status |
|---|
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.LP_SQSp
- LA3_LAS_PPL/SPECT/NOPA_SQS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SQS_1.output.schema.data.spectrum
- LA3_LAS_PPL/PROC/NOPA_SQS_2.x0,LA3_LAS_PPL/PROC/NOPA_SQS_2.y0
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.alive
LA3_LAS_PPL/MDL/MULTI_PATTERN|Periodic SubPattern¶
| projects: | LA3_PPL_PATTERN |
|---|
- LA3_LAS_PPL/MDL/MULTI_PATTERN.userName
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.numberOfLaserPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pulseInterval
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.bunchOffset
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pplTrainDuration
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.bunchOffset
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pplTrainDuration
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternUserSequence
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pplTrainDuration
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pplTrainLength
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.bunchOffset
- LA3_LAS_PPL/MDL/MULTI_PATTERN.xfelBunchCharge,LA3_LAS_PPL/MDL/MULTI_PATTERN.doocsPplPattern,LA3_LAS_PPL/MDL/MULTI_PATTERN.userPplPattern
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pplTrainLength
- LA3_LAS_PPL/MDL/MULTI_PATTERN.applyUserConfigToDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternDoocsSequence
- LA3_LAS_PPL/MDL/MULTI_PATTERN.isMultiPatternAllowed
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.gridFrequencyMode
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.totEmptyPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.numberOfLaserPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pulseInterval
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternType
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.gridFrequencyMode
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pplTrainDuration
- PPL_MULTI_SUBPATTERN.totBurstDuration
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pplTrainLength
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.numberOfEmptyPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.frequencyTable
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.numberOfEmptyPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.totBurstDuration
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.bunchOffset
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.totEmptyPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.patternRepFactor
- LA3_LAS_PPL/MDL/MULTI_PATTERN.writeSequenceToDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.userLaserBit
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.numberOfLaserPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.status
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.gridFrequencyMode
- LA3_LAS_PPL/MDL/MULTI_PATTERN.readFromDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.gridFrequencyMode
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pulseInterval
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pulseFrequency
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_2.pulseFrequency
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.pulseFrequency
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.numberOfEmptyPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.pplTrainLength
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.totEmptyPulses
- PPL_MULTI_SUBPATTERN.status
- LA3_LAS_PPL/MDL/MULTI_PATTERN.userGroupName
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.numberOfLaserPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_0.totEmptyPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pulseInterval
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.numberOfEmptyPulses
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_3.pulseFrequency
- LA3_LAS_PPL/MDL/MULTI_PATTERN.writeToDoocs
- LA3_LAS_PPL/MDL/MULTI_PATTERN.subpattern_1.isOnPplGrid
- LA3_LAS_PPL/MDL/MULTI_PATTERN.baseFrequency
SQS-1030-Status-Scene¶
| projects: | Instrument Timing and Status |
|---|
- LA3_LAS_PPL/CAM/SQS_UNCOMP.output.schema.data.image
- LA3_LAS_PPL/PROC/SQS_UNCOMP.x01d,LA3_LAS_PPL/PROC/SQS_UNCOMP.y01d
- LA3_LAS_PPL/ASENS/EMETER_UNCOMP_SQS_OUT.measurement.pulse
- LA3_LAS_PPL/PROC/SQS_UNCOMP.beamHeight1d,LA3_LAS_PPL/PROC/SQS_UNCOMP.beamWidth1d
PC_EOM_DIAG¶
| projects: | LA3_DIAG |
|---|
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.P_1
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.P_1000
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.tFEupstreamTRG
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToUpstream
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.M_1
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.M_100
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.bDiagState
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.P_10
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.M_1000
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.M_10
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.ADC3Trg
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.lUnits
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.FEdownstreamTRG
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToDownstream
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.tADC3Trg
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.dTrg
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.FEupstreamTRG
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.P_100
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.tFEdownstreamTRG
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.tdTrg
sqs_tune¶
| projects: | LA3_DIAG |
|---|
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_minus_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_pluse_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_minus_96
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToUpstream
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_pluse_96
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_pluse_960
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToDownstream
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_minus_96
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_minus_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_pluse_96
- Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.Stop
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.bDiagState
- Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_XF1_SQS,Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_NOPA1_SQS,Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_1030_SQS,Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_XF2
- Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.Start
scs_tune¶
| projects: | LA3_DIAG |
|---|
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_minus_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_pluse_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_minus_96
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToUpstream
- Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_XF1_SCS,Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_NOPA1_SCS,Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_1030_SCS,Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_XF2
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_pluse_96
- Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.Stop
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_pluse_960
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToDownstream
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_minus_96
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_minus_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_pluse_96
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.bDiagState
- Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.Start
SCS user panel¶
| projects: | LA3_SCS_NOPA |
|---|
- LA3_LAS_PPL/CTRL/TRGDLY.MaxTsDelay
- LA3_LAS_PPL/CTRL/TRGDLY.activeExpPattern
- LA3_LAS_PPL/SPECT/NOPA_SCS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_1.output.schema.data.spectrum
- LA3_LAS_PPL/CTRL/TRGDLY.statusLaserPatternSource
- LA3_LAS_PPL/PROC/NOPA_SCS_2.x01d,LA3_LAS_PPL/PROC/NOPA_SCS_2.y01d
- LA3_LAS_PPL/CTRL/TRGDLY.activeExpPatternApply
- LA3_LAS_PPL/CTRL/TRGDLY.MidTsValue
- LA3_LAS_PPL/CTRL/TRGDLY.delayTsChange
CAM_STATUS¶
| projects: | LA3_DIAG |
|---|
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.CAM_STOP_ACQUIRE
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.camErrorList
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.CAM_all_State
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.all_cam_acquire
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.camErrorList
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.all_cam_trigger_set
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.all_cam_acquire
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.all_cam_trigger_set
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.state
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.CAM_in_Error
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.state
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.all_cam_connectCamera
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.camAllList
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.CAM_all_State
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.CAM_Solve_All_in_ErrorList
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.ALL_CAM_STOP_ACQUIRE
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.camAllList
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.Configure_All_Cams
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.CAM_in_Error
- Macro-CAMStatus-10c0c96a-6902-4a7e-93f0-d18fc434f93d-Camstatus.all_cam_connectCamera
- Macro-CAMStatus-9c413fe4-8c24-4d56-9ac8-78fb6ba348e5-Camstatus.Configure_All_Cams
LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW|View All Patterns¶
| projects: | LA3_PPL_PATTERN |
|---|
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS2.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS2.pplPattern
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_15.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_15.pplPattern
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SCS.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SCS.pplPattern
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SPB.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SPB.pplPattern
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SQS.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SQS.pplPattern
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SASE2.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_SASE2.pplPattern
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS1.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_LAS1.pplPattern
- LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_FXE.bunchCharge,LA3_LAS_PPL/MDL/PATTERNS_OVERVIEW.pplPatterns.LP_FXE.pplPattern
Spectrum¶
| projects: | LA3_SEEDER |
|---|
- LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.wavelengths,LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/SEEDER_SPECTROMETER.refSpectrum
XF1_NF_CAM¶
| projects: | XF1 FE Diagnostic |
|---|
- LA3_LAS_PPL/PROC/FE_XF1_NF.x01d,LA3_LAS_PPL/PROC/FE_XF1_NF.y01d
- LA3_LAS_PPL/CAM/FE_XF1_NF.connectCamera
SCS_NewSettings¶
| projects: | LA3_Settings_Timing |
|---|
- Macro-StoreNew_SCS-6c38d9d1-109f-4d92-9814-1a4c48ae9fa4-Storenew.moreInfo
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.state
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.status
- Macro-StoreNew_SCS-6c38d9d1-109f-4d92-9814-1a4c48ae9fa4-Storenew.storeCurrentSettings
SCS_StoredSettings¶
| projects: | LA3_Settings_Timing |
|---|
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.deviceId
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.status
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.fileContentTable_r
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.remoteState
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.fileDescription
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.newFileDescription
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.state
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.storedFilesTable
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.selectedFile
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.updateComment
SCS_CompareSettings¶
| projects: | LA3_Settings_Timing |
|---|
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.status
- Macro-CompareSettings_SCS-1564cfc4-f1a5-4824-8f10-339867b87d86-Comparesettings.title2
- Macro-CompareSettings_SCS-1564cfc4-f1a5-4824-8f10-339867b87d86-Comparesettings.setting2
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.state
- Macro-CompareSettings_SCS-1564cfc4-f1a5-4824-8f10-339867b87d86-Comparesettings.setting1
- Macro-CompareSettings_SCS-1564cfc4-f1a5-4824-8f10-339867b87d86-Comparesettings.title1
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.storedFilesTable
- Macro-CompareSettings_SCS-1564cfc4-f1a5-4824-8f10-339867b87d86-Comparesettings.contentTable
SCS_LogSettings¶
| projects: | LA3_Settings_Timing |
|---|
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.fileDescription
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.newFileDescription
- LA3_ROUTINE_LOG/ELOGENTRYGENERATOR/SCS_TRIGGER_SETTINGS.status
- LA3_ROUTINE_LOG/ELOGENTRYGENERATOR/SCS_TRIGGER_SETTINGS.elogLogbook
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SCS.selectedFile
- Macro-LogSettings_SCS-88ce0d57-0fe9-4ac6-9e76-df995364bb70-Logbeampositions.execute
FE_XF1_FF¶
| projects: | XF1 FE Diagnostic |
|---|
- LA3_LAS_PPL/PROC/FE_XF1_FF.y01d,LA3_LAS_PPL/PROC/FE_XF1_FF.x01d
- LA3_LAS_PPL/CAM/FE_XF1_FF.connectCamera
x2Timer_trigger¶
| projects: | LA3_DIAG |
|---|
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.lUnits
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.sRegDuration
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.writeDesc
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.lReg
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.sRegDesc
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.lBoard
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.writeDelay
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.sRegDurationCnt
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.sRegDelayCnt
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.writeDuration
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.sRegDelay
- Macro-x2t-e8d18433-7fcc-4c48-89c4-cbe1249c0fa5-Xt.readReg
Timing-changes-800nm¶
| projects: | Instrument Timing and Status |
|---|
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.OXC_status
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Re_Lock_Status
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.LSU_ODL_lock_position_steps
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.def_state
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Curr_Timing_shifter_ps
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.LP_SCSp
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.FB_Reference
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.SFB_En
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Curr_OXC_ODL_position_ps
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.ODL_status
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Timing_shifter_ps
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.OXC_Dis
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Timestamp
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Save
- Macro-master_burst-e4660754-6346-4539-ba85-00f532442e56-MasterBurst.Time_Left
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Restore
- Macro-master_burst-e4660754-6346-4539-ba85-00f532442e56-MasterBurst.Stop
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.lSet
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.LP_SQSp
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.switching_status
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Curr_LSU_ODL_lock_position_steps
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Timing_shifter_offset_ps
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Stop
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.SynchMode
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.OXC_signal_fs
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.SFB_State
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.SFB_Dis
- Macro-master_burst-e4660754-6346-4539-ba85-00f532442e56-MasterBurst.BurstLength
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.SFB_Status
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.OXC_En
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Curr_Timing_shifter_offset_ps
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.train_id
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.OXC_ODL_position_ps
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.RF_harmonic_phase_fs
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Save_Restore_Status
- Macro-master_burst-e4660754-6346-4539-ba85-00f532442e56-MasterBurst.Time_Rq
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.LOCK
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.alive
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.SFB_Ref_RF_HARMONIC
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.Clear
- Macro-master_burst-e4660754-6346-4539-ba85-00f532442e56-MasterBurst.Start
- Macro-ppl_synch-18936dcc-e56e-452c-b4cb-6a8c8e894ac7-PplSynch.SFB_Ref_OXC
PPL_HISTORY¶
| projects: | LA3_DIAG |
|---|
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.pplHistory
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.startDate
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.state
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.execute
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.stopDate
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.instrument
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.interval
- Macro-GetPplHistory-d441cc32-48f2-44fa-90d0-b818d31092b3-GetPplHistory.status
XF1 Near field¶
| projects: | FE output cams |
|---|
- LA3_LAS_PPL/PROC/FE_XF1_NF.beamWidth1d,LA3_LAS_PPL/PROC/FE_XF1_NF.beamHeight1d
- LA3_LAS_PPL/CAM/FE_XF1_NF.connectCamera
- LA3_LAS_PPL/PROC/FE_XF1_NF.x01d,LA3_LAS_PPL/PROC/FE_XF1_NF.y01d
SQS_3rd_stage¶
| projects: | LA3_SQS_NOPA |
|---|
- LA3_LAS_PPL/SPECT/NOPA_SQS_3.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SQS_3.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/NOPA_SQS_3.refSpectrum
- LA3_LAS_PPL/PROC/NOPA_SQS_3.x0,LA3_LAS_PPL/PROC/NOPA_SQS_3.y0
XF1 Far field¶
| projects: | FE output cams |
|---|
- LA3_LAS_PPL/PROC/FE_XF1_FF.y01d,LA3_LAS_PPL/PROC/FE_XF1_FF.x01d
- LA3_LAS_PPL/CAM/FE_XF1_FF.connectCamera
SCS Spectrum and BCC¶
| projects: | LA3_SCS_NOPA |
|---|
- LA3_LAS_PPL/SPECT/NOPA_SCS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_1.output.schema.data.spectrum
- LA3_LAS_PPL/SPECT/NOPA_SCS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_1.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/NOPA_SCS_1.loadBkgSpectrum
All in 1¶
| projects: | Temperature and Humidity |
|---|
- LA3_LAS_PPL/TSENS/TEMP_TABLE_1.value,LA3_LAS_PPL/TSENS/TEMP_TABLE_2.value,LA3_LAS_PPL/TSENS/TEMP_TABLE_3.value,LA3_LAS_PPL/TSENS/TEMP_TABLE_4.value,LA3_LAS_PPL/TSENS/TEMP_TABLE_5.value,LA3_LAS_PPL/TSENS/TEMPERATURE.value,LA3_LAS_PPL/TSENS/TEMP_TABLE_7.value
SCS 3rd Stage¶
| projects: | LA3_SCS_NOPA |
|---|
- LA3_LAS_PPL/PROC/NOPA_SCS_3.x0,LA3_LAS_PPL/PROC/NOPA_SCS_3.y0
- LA3_LAS_PPL/SPECT/NOPA_SCS_3.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_3.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/NOPA_SCS_3.refSpectrum
SCS-1st-stage_test¶
| projects: | LA3_SCS_NOPA |
|---|
- LA3_LAS_PPL/PROC/NOPA_SCS_1.x01d,LA3_LAS_PPL/PROC/NOPA_SCS_1.y01d
- LA3_LAS_PPL/SPECT/NOPA_SCS_2X.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_2X.output.schema.data.spectrum
Status¶
| projects: | LA3_DIAG |
|---|
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.LP_SQSp
- LA3_LAS_PPL/SPECT/NOPA_SCS_2.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SCS_2.output.schema.data.spectrum
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.LP_SCSp
- LA3_LAS_PPL/SPECT/NOPA_SQS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SQS_1.output.schema.data.spectrum
- Macro-LP_read-895df944-636a-4d79-87ac-ff3a6f63fe50-LpRead.alive
SQS 2nd stage¶
| projects: | LA3_SQS_NOPA |
|---|
- LA3_LAS_PPL/PROC/NOPA_SQS_2.x0,LA3_LAS_PPL/PROC/NOPA_SQS_2.y0
- LA3_LAS_PPL/SPECT/NOPA_SQS_2.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SQS_2.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/NOPA_SQS_2.refSpectrum
SQS 1st stage¶
| projects: | LA3_SQS_NOPA |
|---|
- LA3_LAS_PPL/SPECT/NOPA_SQS_1.wavelengths,LA3_LAS_PPL/SPECT/NOPA_SQS_1.output.schema.data.spectrum,LA3_LAS_PPL/SPECT/NOPA_SQS_1.refSpectrum
- LA3_LAS_PPL/PROC/NOPA_SQS_1.x0,LA3_LAS_PPL/PROC/NOPA_SQS_1.y0
LA3_LAS_PPL-CTRL-AC_XF2_DIAG-scene¶
| projects: | LA3_XF2_DIAGNOSTICS |
|---|
- LA3_LAS_PPL/CTRL/AC_XF2_DIAG.output.schema.data.integralX,LA3_LAS_PPL/CTRL/AC_XF2_DIAG.output.schema.data.integralXFit
MOT_BEAM_TEST¶
| projects: | LA3_MIRRORS_CTRL |
|---|
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.motorId
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.On
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.GetTraget
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.CalibrateAll
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Down
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Home
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Move
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Up
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.WriteParams
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Status
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Off
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.selectMotor
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.actualPosition
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.ResetAllErrors
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.all_OFF
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Calibrate
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.targetPosition
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.Stop
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.listMotor
- Macro-mot_beam_prop-418c18f5-2e72-460b-92f3-de54e744d11a-MotBeamProp.all_ON
SCS_ILH_LAS/CAM/8CAM1|scene¶
| projects: | LA3_PROXY |
|---|
- SCS_ILH_LAS/CAM/8CAM1.acquire
- SCS_ILH_LAS/CAM/8CAM1.reset
- SCS_ILH_LAS/CAM/8CAM1.stop
- SCS_ILH_LAS/CAM/8CAM1.trigger
LA3_LAS_PPL/MDL/USER_STARTER|generate_scene¶
| projects: | LA3_LAS_USERSTARTER |
|---|
- LA3_LAS_PPL/MDL/USER_STARTER.startMissing
LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW|layout¶
| projects: | LA3_LAS_OVERVIEW |
|---|
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isTemOk
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isOk
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.inputs.state
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.availableScenes
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isOutputsOk
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.outputs.state
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isDriftOk
- LA3_LAS_PPL/MDL/TEM_XF1_OVERVIEW.isInputsOk
LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW|layout¶
| projects: | LA3_LAS_OVERVIEW |
|---|
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.availableScenes
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.isInputsOk
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.inputs.state
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.isOk
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.isTemOk
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.isOutputsOk
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.isDriftOk
- LA3_LAS_PPL/MDL/TEM_XF2_SQS_OVERVIEW.outputs.state
LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW|layout¶
| projects: | LA3_LAS_OVERVIEW |
|---|
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.outputs.state
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.isOutputsOk
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.isTemOk
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.isDriftOk
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.isInputsOk
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.isOk
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.inputs.state
- LA3_LAS_PPL/MDL/TEM_XF2_SCS_OVERVIEW.availableScenes
SQS_TimingReadOnly¶
| projects: | LA3_Settings_Timing |
|---|
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.newFileDescription
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.state
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.selectedFile
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.storeConfig
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.fileDescription
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.status
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.deviceId
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.updateComment
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.fileContentTable_r
- LA3_ROUTINE_STORE/STORERECALL/TIMING_SQS.storedFilesTable
SQS_NOPA_BEAM_POS_ALL¶
| projects: | Instrument Timing and Status |
|---|
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1V_Status
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1h_n100
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2h_p10
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1H_Status
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.Calibrate
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_V_Up
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1v_p100
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.all_OFF
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_H_Down
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1v_p10
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_motorV_pos
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2h_n10
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_V_Down
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.all_ON
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2H_Status
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1h_n10
- SQS_ILH_LAS/PROC/BS_CAM_800_OU1.x0,SQS_ILH_LAS/PROC/BS_CAM_800_OU1.y0
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_motorH_pos
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_V_Down
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_motorH_pos
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1v_n100
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2v_n10
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2h_p100
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_motorH_limit
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_H_Up
- SQS_ILH_LAS/PROC/BS_CAM_800_OU2.x0,SQS_ILH_LAS/PROC/BS_CAM_800_OU2.y0
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1h_p10
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_H_Down
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1h_p100
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_motorV_limit
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.exp
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_motorV_pos
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2v_n100
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2v_p10
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_H_Up
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1v_n10
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_V_Up
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2V_Status
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L1_motorH_limit
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2_motorV_limit
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2h_n100
- Macro-SQS_beamCtrl-84d28d57-1905-4512-a612-62db0bbbf8d8-SQSBeamctrl.L2v_p100
SCS_NOPA_BEAM_POS_ALL¶
| projects: | Instrument Timing and Status |
|---|
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.Calibrate
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_H_Up
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2v_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorV_pos
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1v_p10
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.all_ON
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_V_Down
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_V_Down
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_p10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_H_Down
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_motorH_pos
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_V_Down
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorH_limit
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2h_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorV_limit
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_motorH_pos
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1v_n100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_motorV_limit
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorH_pos
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_H_Down
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_H_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_n10
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1h_p10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2V_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_n10
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.exp
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_n100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2H_Status
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2h_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_p10
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_motorH_limit
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorH_pos
- 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-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1v_p100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1h_n10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2v_n100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_H_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorV_limit
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_V_Up
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1h_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.all_ON
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_motorH_limit
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.all_OFF
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2h_p10
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_H_Down
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.all_OFF
- SCS_ILH_LAS/PROC/8CAM1.x0,SCS_ILH_LAS/PROC/8CAM1.y0
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2v_n100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2V_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_n100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1v_n10
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1h_n100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_motorV_pos
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1H_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.exp
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1V_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_V_Up
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_motorV_limit
- 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-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_H_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1v_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1_motorV_pos
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1_V_Up
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_p100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1V_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_V_Down
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2v_p10
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2h_n100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2_motorH_limit
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_motorV_pos
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L1H_Status
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2h_p100
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2v_p100
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L2H_Status
- Macro-SCS_beamCtrl-fe6a2a1f-d67e-4d81-9c32-e2c61f422fc1-SCSBeamctrl.L1h_p10
- Macro-SCS_beamCtrl-e6ed130b-d6b2-4a97-98fb-90407d5d3bd5-SCSBeamctrl.L2_V_Up
LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW|layout¶
| projects: | LA3_LAS_OVERVIEW |
|---|
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.isOk
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.outputs.state
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.isInputsOk
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.availableScenes
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.isAmphosOk
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.isOutputsOk
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.inputs.state
LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW|overview¶
| projects: | LA3_LAS_OVERVIEW |
|---|
- LA3_LAS_PPL/MDL/AMPHOS_OVERVIEW.device
SQS_1030nm_BEAM_POS_ALL¶
| projects: | Instrument Timing and Status |
|---|
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_V_Down
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_H_Down
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1h_n100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_motorH_pos
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2v_p10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_motorH_limit
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.all_ON
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_H_Down
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1v_n10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1H_Status
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1v_p10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2H_Status
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2v_n100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.all_OFF
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1h_p100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_motorV_pos
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2h_p10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2v_n10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1h_p10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_H_Up
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1v_n100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2h_n10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_V_Down
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_motorH_pos
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_V_Up
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2V_Status
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_motorV_limit
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2v_p100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.exp
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1V_Status
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2h_n100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.Calibrate
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_motorH_limit
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1v_p100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2h_p100
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_motorV_pos
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1h_n10
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_V_Up
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L2_motorV_limit
- Macro-SQS_uncomp_beamCtrl-65100678-bf7f-4479-8962-62266dfe9a16-SQSUncompBeamctrl.L1_H_Up
SCS_1030nm_BEAM_POS_ALL¶
| projects: | Instrument Timing and Status |
|---|
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_motorH_pos
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2v_p100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.all_ON
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_V_Down
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1v_n100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_H_Up
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_motorV_pos
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_H_Down
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_motorH_limit
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_H_Down
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1h_p100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_H_Up
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_motorH_pos
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1v_p100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_V_Down
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1v_n10
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1h_n10
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.exp
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_motorH_limit
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1h_p10
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1V_Status
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_motorV_pos
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_V_Up
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1_motorV_limit
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2h_p100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_motorV_limit
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2h_p10
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2h_n10
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2_V_Up
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2v_n10
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2v_n100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.Calibrate
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1v_p10
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2V_Status
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2H_Status
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.all_OFF
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2h_n100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1h_n100
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L1H_Status
- Macro-SCS_uncomp_beamCtrl-2d98aed8-ac63-42cd-8d30-274291157419-SCSUncompBeamctrl.L2v_p10
WorkInHutch¶
| projects: | LA3_TIMING |
|---|
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.WorkStart
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.def_state
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.user_phone
- LA1_LAS_PPL/CTRL/TRGDLY.mBurstWidthApply
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.S_AOM_inv
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_off
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.user_phone
- LA1_LAS_PPL/CTRL/TRGDLY.pCellOff
- LA1_LAS_PPL/CTRL/TRGDLY.delayBPMaster
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.user_name
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.user_error
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.sPC_off
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.workEn
- LA1_LAS_PPL/CTRL/TRGDLY.masterExpPattern
- LA1_LAS_PPL/CTRL/TRGDLY.slaveExpPattern
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sAOM_inv
- LA1_LAS_PPL/CTRL/TRGDLY.sPCCLKPhaseM
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.workEn
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.M_AOM_inv
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.sPC_on
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.sAOM_inv
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mPC_on
- LA1_LAS_PPL/CTRL/TRGDLY.savesSWPCCLKPhase
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.WorkEnd
- LA1_LAS_PPL/CTRL/TRGDLY.delayBPMasterP
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_off
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.work_start
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.work_start
- LA1_LAS_PPL/CTRL/TRGDLY.savemSWPCCLKPhase
- LA1_LAS_PPL/CTRL/TRGDLY.pCellState
- LA1_LAS_PPL/CTRL/TRGDLY.delayBPSlave
- LA1_LAS_PPL/CTRL/TRGDLY.mSWPCCLKPhase
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.mPC_on
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.S_AOM_inv
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.mAOM_inv
- LA1_LAS_PPL/CTRL/TRGDLY.AOMOn
- LA1_LAS_PPL/CTRL/TRGDLY.AOMOff
- LA1_LAS_PPL/CTRL/TRGDLY.mPCCLKPhase
- LA1_LAS_PPL/CTRL/TRGDLY.sBurstWidthApply
- LA1_LAS_PPL/CTRL/TRGDLY.AOMState
- LA1_LAS_PPL/CTRL/TRGDLY.mPCCLKPhaseP
- LA1_LAS_PPL/CTRL/TRGDLY.sPCCLKPhaseP
- LA1_LAS_PPL/CTRL/TRGDLY.delayBPSlaveP
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.sPC_on
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.WorkStart
- LA1_LAS_PPL/CTRL/TRGDLY.mPCCLKPhaseM
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.WorkEnd
- LA1_LAS_PPL/CTRL/TRGDLY.sPCCLKPhase
- LA1_LAS_PPL/CTRL/TRGDLY.mBurstWidth
- LA1_LAS_PPL/CTRL/TRGDLY.sBurstWidth
- LA1_LAS_PPL/CTRL/TRGDLY.delayBPSlaveM
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.M_AOM_inv
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.user_name
- LA1_LAS_PPL/CTRL/TRGDLY.delayBPMasterM
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.mPC_off
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.user_error
- Macro-work_in_hutch-c452c29a-a58a-4dca-a21b-1273e40fca76-WorkInHutch.def_state
- Macro-AomPcCtrl-4b0f5ea3-3a72-4d06-bda4-371d222a9edd-Aompcctrl.mAOM_inv
- LA1_LAS_PPL/CTRL/TRGDLY.sSWPCCLKPhase
- LA1_LAS_PPL/CTRL/TRGDLY.pCellOn
PC-and-AOM-settings¶
| projects: | LA3_TIMING |
|---|
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.sPC_off
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.AOM_OFF
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.Pockels_Cell_Off
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.def_state
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.S_AOM_inv
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.mPC_on
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.mPC_off
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.M_AOM_inv
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.Pockels_Cell_On
- Macro-work_in_hutch-2ef3ef4c-daf0-43c9-be02-db80d03b868b-WorkInHutch.AOM_ON
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.mAOM_inv
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.sPC_on
- Macro-AomPcCtrl-b9b67870-e3a9-4cea-a8a6-cc45be1f5a28-Aompcctrl.sAOM_inv
ADQ14¶
| projects: | LA3_DIAG |
|---|
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.p_1
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.dev_status
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.writeDelay
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.n_1000
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.n_10000
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.p_50ms
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.writeDelay_t
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.n_1
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.n_100
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.p_10
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.p_1000
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.p_10000
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.n_10
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.INIT
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.p_100
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.sRegDelay
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.lUnits
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.sRegDelayCnt
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.newDelay
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.readReg
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.n_50ms
- Macro-aqd_trg-56eb4ee5-2283-4502-942a-3737b6842fbc-AqdTrg.newDelay_t
scs_sqs_monitoring¶
| projects: | LA3_DIAG |
|---|
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_minus_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_pluse_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_minus_96
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToUpstream
- Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_XF1_SCS,Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_NOPA1_SCS,Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_1030_SCS,Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.PD_XF2
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Master_LP_delay_pluse_96
- Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.Stop
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_pluse_960
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.setDiagToDownstream
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_minus_96
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_minus_960
- Macro-timing_ext-db4e4ffe-50d3-4941-b3fd-8a37c3fd37dc-TimingExt.Slave_LP_delay_pluse_96
- Macro-ADC_DIAG_TRG-8ce4f8d7-2307-4cab-b89e-b26ae9dabf98-AdcDiagTrg.bDiagState
- Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_XF1_SQS,Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_NOPA1_SQS,Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_1030_SQS,Macro-adc_proc_sqs-1f48ce6a-b732-4a98-a32e-0b7f6ba6a81b-AdcProcSQS.PD_XF2
- Macro-adc_proc_scs-61c2d25f-ed69-4158-aac4-47d1c2bdfeac-AdcProcSCS.Start
SQS_Pointing_Campaign¶
| projects: | SQS_Pointing-Campaign |
|---|
- LA3_LAS_PPL/CAM/SQS_POINTING_CAMPAIGN.acquire,LA3_LAS_PPL/CAM/SQS_POINTING_CAMPAIGN.stop
- LA3_LAS_PPL/PROC/SQS_POINTING_CAMPAIGN.x0,LA3_LAS_PPL/PROC/SQS_POINTING_CAMPAIGN.y0
- LA3_LAS_PPL/CAM/SQS_POINTING_CAMPAIGN.output.schema.data.image
SQS_1030nm¶
| projects: | LA3_1030NM |
|---|
- LA3_LAS_PPL/CAM/SQS_1030.acquire,LA3_LAS_PPL/CAM/SQS_1030.stop
- LA3_LAS_PPL/PROC/SQS_1030.x0,LA3_LAS_PPL/PROC/SQS_1030.y0
PoE_Switches_239x_m¶
| projects: | LA3_DIAG |
|---|
- LA3_LAS_PPL/POE/10_253_14_239_24.deviceId
- LA3_LAS_PPL/POE/10_253_14_239_14.off
- LA3_LAS_PPL/POE/10_253_14_239_16.on
- LA3_LAS_PPL/POE/10_253_14_239_8.state
- LA3_LAS_PPL/POE/10_253_14_239_22.port
- LA3_LAS_PPL/POE/10_253_14_239_22.state
- LA3_LAS_PPL/POE/10_253_14_239_20.off
- LA3_LAS_PPL/POE/10_253_14_239_20.deviceId
- LA3_LAS_PPL/POE/10_253_14_239_20.state
- LA3_LAS_PPL/POE/10_253_14_239_14.deviceId
- LA3_LAS_PPL/POE/10_253_14_239_22.deviceId
- LA3_LAS_PPL/POE/10_253_14_239_22.on
- LA3_LAS_PPL/POE/10_253_14_239_16.port
- LA3_LAS_PPL/POE/10_253_14_239_8.port
- LA3_LAS_PPL/POE/10_253_14_239_16.off
- LA3_LAS_PPL/POE/10_253_14_239_8.deviceId
- LA3_LAS_PPL/POE/10_253_14_239_16.state
- LA3_LAS_PPL/POE/10_253_14_239_8.on
- LA3_LAS_PPL/POE/10_253_14_239_24.port
- LA3_LAS_PPL/POE/10_253_14_239_20.port
- LA3_LAS_PPL/POE/10_253_14_239_20.on
- LA3_LAS_PPL/POE/10_253_14_239_14.on
- LA3_LAS_PPL/POE/10_253_14_239_16.deviceId
- LA3_LAS_PPL/POE/10_253_14_239_14.state
- LA3_LAS_PPL/POE/10_253_14_239_24.on
- LA3_LAS_PPL/POE/10_253_14_239_22.off
- LA3_LAS_PPL/POE/10_253_14_239_24.state
- LA3_LAS_PPL/POE/10_253_14_239_8.off
- LA3_LAS_PPL/POE/10_253_14_239_24.off
- LA3_LAS_PPL/POE/10_253_14_239_14.port
SCS_1030nm¶
| projects: | LA3_1030NM |
|---|
- LA3_LAS_PPL/CAM/SCS_1030.acquire,LA3_LAS_PPL/CAM/SCS_1030.stop
- LA3_LAS_PPL/PROC/SCS_1030.x0,LA3_LAS_PPL/PROC/SCS_1030.y0
- LA3_LAS_PPL/PROC/SCS_1030.sx,LA3_LAS_PPL/PROC/SCS_1030.sy