mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-11-18 17:24:04 +01:00
248 lines
7.8 KiB
Markdown
248 lines
7.8 KiB
Markdown
# SLS Detector Package {{RELEASE_TYPE}} Release {{VERSION}} released on {{DATE}}
|
|
|
|
This document describes the differences between v{{VERSION}} and v{{PREVIOUS_VERSION}}
|
|
|
|
## Contents
|
|
|
|
1. [New, Changed or Resolved Features](#1-new-changed-or-resolved-features)
|
|
1. [Compilation](#11-compilation)
|
|
2. [Callback](#12-callback)
|
|
3. [Python](#13-python)
|
|
4. [Client](#14-client)
|
|
5. [Detector Server](#15-detector-server)
|
|
1. [Jungfrau](#151-jungfrau)
|
|
2. [Eiger](#152-eiger)
|
|
3. [Moench](#153-moench)
|
|
4. [Gotthard2](#154-gotthard)
|
|
5. [Mythen3](#155-mythen)
|
|
6. [Simulator](#16-simulator)
|
|
7. [Receiver](#17-receiver)
|
|
8. [Gui](#18-gui)
|
|
2. [BugFixes](#2-bugfixes)
|
|
1. [Python](#21-python)
|
|
2. [Client](#22-client)
|
|
3. [Detector Server](#23-detector-server)
|
|
1. [Jungfrau](#231-jungfrau)
|
|
2. [Eiger](#232-eiger)
|
|
3. [Moench](#233-moench)
|
|
4. [Gotthard2](#234-gotthard)
|
|
5. [Mythen3](#235-mythen)
|
|
4. [Simulator](#4-simulator)
|
|
5. [Receiver](#5-receiver)
|
|
6. [Gui](#26-gui)
|
|
3. [On-board Detector Server Compatibility](#2-on-board-detector-server-compatibility)
|
|
4. [Firmware Requirements](#3-firmware-requirements)
|
|
5. [Kernel Requirements](#4-kernel-requirements)
|
|
6. [Download, Documentation & Support](#5-download-documentation--support)
|
|
|
|
## 1 New, Changed or Resolved Features
|
|
|
|
### 1.1 Compilation
|
|
|
|
### 1.2 Callback
|
|
|
|
### 1.3 Python
|
|
|
|
### 1.4 Client
|
|
|
|
### 1.5 Detector Server
|
|
|
|
**General Detector Updates:**
|
|
|
|
**Detector Specific updates:**
|
|
|
|
#### 1.5.1 Jungfrau
|
|
|
|
#### 1.5.2 Eiger
|
|
|
|
#### 1.5.3 Moench
|
|
|
|
#### 1.5.4 Gotthard2
|
|
|
|
#### 1.5.5 Mythen3
|
|
|
|
### 1.6 Simulator
|
|
|
|
### 1.7 Receiver
|
|
|
|
### 1.8 Gui
|
|
|
|
## 2 BugFixes
|
|
|
|
### 2.1 Python
|
|
|
|
### 2.2 Client
|
|
|
|
### 2.3 Detector Server
|
|
|
|
**General Detector BugFixes:**
|
|
|
|
**Detector Specific BugFixes:**
|
|
|
|
#### 1.5.1 Jungfrau
|
|
|
|
#### 1.5.2 Eiger
|
|
|
|
#### 1.5.3 Moench
|
|
|
|
#### 1.5.4 Gotthard2
|
|
|
|
#### 1.5.5 Mythen3
|
|
|
|
### 2.4 Simulator
|
|
|
|
### 2.5 Receiver
|
|
|
|
### 2.6 Gui
|
|
|
|
## 3 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`
|
|
- udpate both on-board detector server and firmware simultaneously
|
|
- Using command `update`
|
|
|
|
Instructions available at
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/serverupgrade.html
|
|
|
|
## 4 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 `programfpga` or
|
|
- udpate both on-board detector server and firmware simultaneously
|
|
- Using command `update`
|
|
|
|
Instructions available at
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/firmware.html
|
|
|
|
## 5 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
|
|
|
|
## 6 Download, Documentation & Support
|
|
|
|
### Download
|
|
|
|
- **The Source Code:**
|
|
- https://github.com/slsdetectorgroup/slsDetectorPackage
|
|
- **RPM Packages:**
|
|
- https://gitea.psi.ch/detectors/-/packages
|
|
|
|
### Documentation
|
|
|
|
- **Installation:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/installation.html
|
|
- **Quick Start Guide:**
|
|
- https://slsdetectorgroup.github.io//{{VERSION}}/quick_start_guide.html
|
|
- **Firmware Upgrade:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/firmware.html
|
|
- **Detector Server upgrade:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/serverupgrade.html
|
|
- **Detector Simulators:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/virtualserver.html
|
|
- **Consuming slsDetectorPackage:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/consuming.html
|
|
- **Software Architecture:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/softwarearchitecture.html
|
|
- **Set up commands in config file:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/configcommands.html
|
|
- **Image Size and Output Characteristics:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/dataformat.html
|
|
- **API Examples:**
|
|
- https://github.com/slsdetectorgroup/api-examples
|
|
- **Command Line Documentation:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/commandline.html
|
|
- **C++ API Documentation:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/detector.html
|
|
- **C++ API Example:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/examples.html#
|
|
- **Python API Documentation:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/pygettingstarted.html
|
|
- **Python API Example:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/pyexamples.html
|
|
- **Receivers (including custom receiver):**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/receivers.html
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/slsreceiver.html
|
|
- **Detector UDP Header:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/udpheader.html
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/udpdetspec.html
|
|
- **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:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/slsreceiver.html#zmq-json-header-format
|
|
- **TroubleShooting:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/troubleshooting.html
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/{{VERSION}}/troubleshooting.html#receiver-pc-tuning-options
|
|
- **Further Documentation:**
|
|
- https://www.psi.ch/en/detectors/documentation
|
|
- **Info on Releases:**
|
|
- https://slsdetectorgroup.github.io/slsDetectorPackage/index.html
|
|
|
|
### Support
|
|
|
|
- dhanya.thattil@psi.ch
|
|
- erik.frojdh@psi.ch
|
|
- alice.mazzoleni@psi.ch
|