Files
Jungfraujoch/broker/README.md

1.5 KiB

Jungfraujoch service (jfjoch_broker)

'jfjoch_broker' is the main service for the Jungfraujoch application. It is responsible for:

  • Providing user interface via HTTP and OpenAPI
  • Configuring FPGA firmware
  • Building images from FPGA output and forwarding the results over ZeroMQ

Description of OpenAPI is presented in the redoc-static.html file. Due to limitations of GitLab/GitHub the file cannot be viewed directly from the repository, but needs to be downloaded.

Broker configuration

'jfjoch_broker' requires JSON configuration files. At the moment the format of the configuration file is not properly documented. Till this happens, it is recommended to go through example files in the etc/.

Setting up a local test for Jungfraujoch

For development, it is possible to setup a local installation of Jungfraujoch. This will work without FPGA installed in the computer and allows to test Jungfraujoch software layer, including ZeroMQ streaming and file writing. There are few necessary steps:

Compile Jungfraujoch with frontend

git submodule update --init --recursive
mkdir build
cd build
cmake ..
make jfjoch
make frontend

Start services

Start broker:

cd build/broker
./jfjoch_broker ../../etc/broker_local.json 5232

Start writer:

cd build/writer
./jfjoch_writer tcp://127.0.0.1:5500

Run tests

To run test a Python script is provided:

cd tests/test_data
python jfjoch_broker_test.py

The script will initialize Jungfraujoch, import test image and start data collection.