9.2 KiB
SLS Detector Package Minor Release 10.1.0 released on 2026-08-06
This document describes the differences between v10.1.0 and v10.0.1
Contents
- New, Changed or Resolved Features
- On-board Detector Server Compatibility
- Firmware Requirements
- Kernel Requirements
- Download, Documentation & Support
1 New, Changed or Resolved Features
support for building rpms
removed unused function readDataFile/writeDataFile from file_utils.h
added rx_streamdummyheader to send the zmq dummy header any time. Allows pre-configuring zmq processing before acq begins.
zmqsocket - allowing hwm to be set already at the constructor level. As before, can still be set after construction with socket reconnection.
M3: threshold energy updated to -1 in receiver master file whenever it is set in the detector server (setting dacs directly, custom trimbit file, set all trimbits etc.)
eiger seting vthreshold dac directly should change settings to undefined. done.
1.1 Compilation
- Building shared libraries is disabled by default. If you need to link against any of the
libSls*.solibraries, you can enable this by passing-DSLS_BUILD_SHARED_LIBRARIES=ONto CMake. - Added
SLS_USE_SYSTEM_ZMQoption (defaultOFF) to use the libzmq of the host instead of the one included in our repo. - Experimental support for building the detector client (including python bindings) on macOS
- libfmt added to dependency
- support for building rpms
- documentation for all branches and developer now online and build and pushed automatically
1.2 Callback
1.3 Python
Detector.pattern(python) accepts also a pattern object, not only a pattern file- added
patternstartto python (ctb, xilinx_ctb, mythen3), only the detector class api was exposed (startPattern()) - python dacs => using deprecated
np.int. dacs return float (default dtype of numpy) => changed tonp.int32(meant for v10.0.1)
1.4 Client
- m3:
getPatternFileNametypo fixed - removed unused function
readDataFile/writeDataFilefromfile_utils.h - changed api:
datastream=>udp_datastream,set/getDatastream=>set/getUDPDatastream; also implemetned for jungfrau, moench at receiver side (top/bottom) - setting number of UDP interfaces can only be set at detector level and not at module level. (individual modules)
1.5 Detector Server
- m3: fixed
patwaittimein intervals, which is hardly used.patwaittimein clocks stays the same and working.
1.6 Simulator
- can build virtual servers on mac OS
1.7 Receiver
rx_dbitlistkeeps the order of the passed bit list- added
rx_streamdummyheaderto send the zmq dummy header any time. Allows pre-configuring zmq processing before acq begins. - allow disabling one UDP interface in the receiver.
- zmqsocket - allowing hwm to be set already at the constructor level. As before, can still be set after construction with socket reconnection.
1.8 Gui
- gui: mouse zooms not reset at start of acquisition
2 On-board Detector Server Compatibility
| Detector | Version |
|---|---|
| Eiger | 10.0.0 |
| Jungfrau | 10.0.0 |
| Mythen3 | 10.0.0 |
| Gotthard2 | 10.0.0 |
| Moench | 10.0.0 |
On-board Detector Server Upgrade
From v6.1.0 (without tftp):
- update only on-board detector server
- Using command
updatedetectorserver
- Using command
- udpate both on-board detector server and firmware simultaneously
- Using command
update
- Using command
Instructions available at
3 Firmware Requirements
| Detector | Firmware Date | Version | Updated in |
|---|---|---|---|
| Eiger | 02.10.2023 | v32 | 7.0.3 |
| Jungfrau | 09.02.2025 | v1.6, HW v1.0 | 9.1.0 |
| Jungfrau | 08.02.2025 | v2.6, HW v2.0 | 9.1.0 |
| Mythen3 | 13.11.2024 | v2.0 | 9.0.0 |
| Gotthard2 | 03.10.2024 | v1.0 | 9.0.0 |
| Moench | 26.10.2023 | v2.0 | 8.0.2 |
Detector Upgrade
The following can be upgraded remotely:
| Detector | Upgrade via |
|---|---|
| Eiger | bit files |
| Jungfrau | command <.pof> |
| Mythen3 | command <.rbf> |
| Gotthard2 | command <.rbf> |
| Moench | command <.pof> |
Except Eiger,
- upgrade
- Using command
programfpgaor
- Using command
- udpate both on-board detector server and firmware simultaneously
- Using command
update
- Using command
Instructions available at
4 Kernel Requirements
Blackfin
Latest version: Fri Oct 29 00:00:00 2021
Older ones will work, but might have issues with programming firmware via the package.
Nios
Compatible version: Mon May 10 18:00:21 CEST 2021
Kernel Upgrade
| Detector | Upgrade via |
|---|---|
| Eiger | bit files |
| Others | command |
Commands: udpatekernel, kernelversion
Instructions available at
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/commandline.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/detector.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/pydetector.html
5 Download, Documentation & Support
Download
- The Source Code:
- RPM Packages:
Documentation
- Installation:
- Quick Start Guide:
- Firmware Upgrade:
- Detector Server upgrade:
- Detector Simulators:
- Consuming slsDetectorPackage:
- Software Architecture:
- Set up commands in config file:
- Image Size and Output Characteristics:
- API Examples:
- Command Line Documentation:
- C++ API Documentation:
- C++ API Example:
- Python API Documentation:
- Python API Example:
- Receivers (including custom receiver):
- Detector UDP Header:
- Output Data:
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/dataformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/fileformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/slsreceiverheaderformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/masterfileattributes.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/binaryfileformat.html
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/hdf5fileformat.html
- slsReceiver Zmq Format:
- TroubleShooting:
- Further Documentation:
- Info on Releases: