slsDetectorPackage/docs/src/quick_start_guide.rst

Quick Start Guide

Detector

Start up detector (with cooling if required). Ensure both control server and stop server is running on-board.

Or use a detector simulator to test. Click here<Virtual Detector Servers> for further instructions.

Receiver

One has to start the slsReceiver before loading config file or using any receiver commands (prefix: rx_ )

For a Single Module

# default port 1954
slsReceiver

# custom port 2012
slsReceiver -p 2012

For Multiple Modules

# slsMultiReceiver [-p: starting port, -n: number of receivers]
slsMultiReceiver -p 2012 -n 2 

Client

Refer Sample Config file to create config file.

# load config file
sls_detector_put config /path/sample.config

# set number of frames
sls_detector_put frames 5

# acquire
sls_detector_acquire

Sample Config file

There are sample config files for each detector in slsDetectorPackage/examples folder.

For a Single Module

# connects to module
hostname bchipxxx

# connects to receiver at default port
rx_hostname mpc1922
# or to connect to specific port
# rx_hostname mpc1922:2012

# sets destination udp ports (not needed, default is 50001)
udp_dstport 50012

# 1g data out
# source udp ips must be same subnet at destintaion udp ips
# udp_srcip 192.168.1.112
# destination udp ip picked up from rx_hostname (if auto)
# udp_dstip auto

# 10g data out
udp_srcip 10.30.20.200
udp_dstip 10.30.20.6

# set file path
fpath /tmp

For a Single Module with custom Receiver (not slsReceiver)

# connects to module
hostname bchipxxx

# sets destination udp ports (not needed, default is 50001)
udp_dstport 50012

# source udp ips must be same subnet at destintaion udp ips
udp_srcip 192.168.1.112

# destination udp ip 
udp_dstip 192.168.1.100

# source udp mac 
udp_srcmac aa:bb:cc:dd:ee:ff

# destination udp mac 
udp_dstmac 3c:ab:98:bf:50:60

# set file path
fpath /tmp

For Multiple Modules

# connects to mulitple modules
hostname bchipxxx+bchipyyy+

# tcp port increases for each module (multi detector command)
rx_tcpport 2012

# connects to receivers at ports 2012 and 2014
rx_hostname mpc1922

# increasing udp ports (multi detector command)
udp_dstport 50012

# source udp ips must be same subnet at destintaion udp ips
0:udp_srcip 192.168.1.112
1:udp_srcip 192.168.1.114

# destination udp ip picked up from rx_hostname (if auto)
udp_dstip auto

# set file path
fpath /tmp

Data

Check out the UDP header section<detector udp header> for details on output UDP header data format.`

Check out the Detector image size and format section<data format> for details on output data format.

Receiver

When using slsReceiver, slsMultiReceiver or slsFrameSynchronizer, check out the following sections:

• File format<file format>
• slsReceiver header format<sls receiver header format>
• Master file attributes<master file attributes>

Gui

Compile with SLS_USE_GUI=ON in cmake or -g option in cmk.sh script. One can also just use the conda binary. Refer installation instructions<Installation>.

slsDetectorGui