graphical-alarm-client

An operator desktop human machine interface (HMI) client application for JAWS. Written in Python with QT and allows operators to:

• List active alarms
• List registered alarms
• List shelved alarms
• Shelve alarms
• Acknowledge alarms
• Suppress alarms

Docker

docker-compose up

Connect to the gui container via a bash terminal:

docker exec -it gui bash

Note: The environment variable DOCKER_DISPLAY must be set according to your host OS and X-Windows configuration. This environment variable can be stored in a file named .env in the same directory as the docker-compose.yml file.

Note: Use "docker-compose down" to cleanup

Note: The scripts directory is mounted as a volume in the gui container to facilitate development activities: changes are reflected inside the container and on the host so they can be persisted to git version control.

Docker Build

docker build . -t gui 

Note: If building from on the JLab network you'll need to add the following additional build argument:

--build-arg CUSTOM_CRT_URL=http://pki.jlab.org/JLabCA.crt

Docker Run

All of the containers must communicate, which is easiest if they're all on the same Docker network. Also, an X-Windows DISPLAY environment variable must be set properly in order to see the display. Docker compose makes this easier, but if you want to just run the gui container use:

docker run -rm -it -e DISPLAY=? -e BOOTSTRAP_SERVERS=kafka:9092 -e SCHEMA_REGISTRY=http://registry:8081 -v ? --network=graphical-net --entrypoint bash gui

Where BOOTSTRAP_SERVERS and SCHEMA_REGISTRY refer to valid Kafka and Registry hosts on the custom Docker network graphical-net that you've created. The DISPLAY is host dependent and so is the relative path in the volume option:

macOS:

-e DISPLAY=$ip:0 -v $(pwd)/scripts:/scripts

Windows:

-e DISPLAY=host.docker.internal:0 -v %cd%/scripts:/scripts

Linux:

-e DISPLAY=:0 -v $(pwd)/scripts:/scripts

Note: This Docker container requires a local X-Windows server, on Microsoft Windows and Mac in particular you may need to launch one.

Attributions: Some icons by Yusuke Kamiyamane. Licensed under a Creative Commons Attribution 3.0 License.