# Welcome to AIBS Documentation’s documentation!

Contents:

## Logging Into The AIBS Karabo Interface

The AIBS Karabo configuration interface is accessible via a special display node, to which only certain users have access.

To log onto this node, go to the address communicated to you in a web browser. This will open a FastX webinterface. You will see a login page, where you need to give your standard XFEL computing credentials.

After logging in you will see the session select screen of FastX. If you’ve previously logged in you can select your already running session here, if its your first log in, click launch session, then select XFCE and click Launch.

If you’ve started a new session, you will see a page open up with an empty desktop environment, similar to the one below.

In case you launched your previous session, your Desktop will already contain the applications you’ve last used.

## Starting the Karabo GUI in FastX and Connecting to the AIBS

On the Desktop, select Applications in the top left corner and open a Terminal Emulator

In the terminal that opens type the following command:

    module load exfel karabo-gui
    karabo-gui

This will launch a Karabo-GUI. In the login information, select expert as user and enter the special port number (available from Z. Ansari upon request). Then click “connect”.

You are now logged into the AIBS Karabo interface.

## Viewing AIBS System Status

First login to the AIBS Karabo GUI (Logging Into The AIBS Karabo Interface).

Then switch to the Topology View of the GUI. The AIBS devices are found under each SASE’s “SRP_AIBS” group.

To view a particular AIBS, double click on its entry. You should see the standard AIBS scene.

On this scene you will see an overview of the AIBS status.

At the top you find the ID of the AIBS device you are viewing, as well as a link to the expert configuration scene. Below which the state of the Karabo device and the hardware state the PLC evaluates for the AIBS is given. Inset is the alarm status, which will be “C” for “Critical” if one of the sensors reports an alarm.

The following states might be reported:

INIT: | The Karabo device is waiting to connect to the PLC.
ACTIVE: | The device is running normally and will report any sensor alerts through its alert level.
UNKNOWN: | The Karabo-PLC connection is severed. A EEE or CTRL expert should be contacted.
ERROR: | The PLC evaluated a hardware error on the AIBS. A EEE expert should be contacted. Importantly An ERROR is not indicative of a test failure. Rather, if the device is in ERROR state, test results might not be accurately reported.
INTERLOCK BROKEN:
| If the interlocks acting on the MPS for a given AIBS are deactivated, this state will be show. The sensor alerts are unaffected by this state and will be indicated normally.
ACQUIRING: | This is a transient state while sensor tests are being run
STARTING: | This is a transient state while the Karabo device is starting.

The following alerts might be reported as insets:

ALARM: | Will show a “C” as in “Critical” within a red polygon. This indicates that the AIBS registered a sensor alarm which could not be resolved after a sensor self-test.
OK: | Will show “OK” in a green box.

In the central part of the scene the sensor specific status and settings are reported. For each sensor the followin status is given:

Test Active: | Did the sensor trigger a test. Reports as IDLE or TEST.
Test LED Active:
| Is the test LED of the sensor currently on. Indicated as OFF and ON.
Sensor Alarm: | Is the sensor currently reporting an alarm. Will be indicated as FAIL and PASS.
Diagnostics Alarm:
| Is the sensor currently a diagnostics alarm, i.e. did a self-test fail. Will be indicated as FAIL and PASS.
Triggered Test: | Did this sensor trigger a diagnostics test. Indicated as YES or NO.

Additionally, the diagnostics interval and the test window are indicated for each sensor.

At the bottom part of the the scene the evaluation window is indicated and alarms can be reset. In this case a self-test of both sensors is triggered automatically.

## Configuring the AIBS Parameters Through Karabo

To reach the configuration interface, followin the instructions for opening the status scene (Viewing AIBS System Status), and click on the Expert View link in that scene.

A scene very similar to the status scene will show, but importantly it will allow you to alter certain parameters.

To change any of Sensor Interval, Sensor Window or Window, type the new value and hit enter. Values might be allowed within certain ranges only and if the value will be rejected if out of range.

The ranges are as follows:

Sensor Interval:
| 5 minutes to 1440 minutes (1 day)
Sensor Window: | 5 minutes to 40 minutes
Window: | 100 to 3500 ms.

### Expert Actions

The expert scene allows for certain “Expert” actions:

Reboot AIBS: | Reboots the AIBS hardware. The Karabo device will go into the INIT state until a connection to the AIBS is reestablished.
Activate Interlocks:
| Active all interlocks onto the MPS relevant for this AIBS. The AIBS should report the ACTIVE state if it was previously in INTERLOCK_BROKEN or will report any other state that the hardware and PLC is in, e.g. ACQUIRING or IDLE in case of a reboot.
Deactivate Interlocks:
| Deactivate all interlocks onto the MPS relevant for this AIBS. The AIBS will report the INTERLOCK_BROKEN state.
Enable/Disable External Write:
| This is needed for firmware updates and should be done in consultation with EEE / D3 experts.

## Alarms & Notifications from the AIBS

The AIBS sends out notifications on alarms raised by the system to the Karabo notifications service, which in turn forwards the alarm to two email lists:

aibs-mps@xfel.eu:
| will be notified if an AIBS device reports one of the MPS interlock signals

it interacts with is disabled, i.e. the AIBS would not trigger the interlock. It furthermore watches the interlocks themselves and will trigger if the AIBS initiated and interlock signal to the MPS.

aibs-sensor@xfel.eu:
| will be notified if any of the AIBS devices raises an alarm on its sensors, i.e. if

a sensor fails the self-test procedure.

Both groups are notified if the Karabo devices they monitor are offline, i.e. notifications are not sent in case of the events above.

In case of an event the notificaitons are sent within a 5 minute interval of the event. In case an event persists, notifications are repeated every 12 hours.

### Acknowledging Alarms

Alarms on the AIBS are configured to latch, i.e. even if the alarm condition is not present anymore, the alarm is retained and recurrent notifications are sent until the alarm is acknowledged. To acknowledge an alarm perform the following steps.

First, open the alarm panel in Karabo. It is accessible from the main Karabo GUI menu.

It will open in the central panel of the GUI. You should now see any pending alarms on the system. If an alarm condition is not there anymore the alarm can be acknowledeged by clicking the button to the far right.

# Indices and tables

- Index
- Module Index
- Search Page