mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-19 18:40:01 +02:00
Dhanya Thattil
297c3752e3
* slsSupportLib done, at receiver rooting out in implementation * removed from receiver and client * removed everywhere except gui, python and client(commands.yaml and Detector.h) * updated python * fixed autocomplete to print what the issue is if there is one with ToString when running the autocomplete script to generate fixed.json. updated readme.md in generator folder * formatting * removed enums for dacs * udpating autocomplete and generating commands * removed gotthard from docs and release notes * removed dac test * bug from removing g1 * fixed virtual test for xilinx, was minor. so in this PR * gui done * binary in merge fix * formatting and removing enums * updated fixed and dump.json * bash autocomplete * updated doc on command line generation * removing increments in dac enums for backward compatibility. Not required * removed ROI from rxParameters (only in g1), not needed to be backward compatible * removed the phase shift option from det server staruip
209 lines
5.2 KiB
Plaintext
209 lines
5.2 KiB
Plaintext
SLS Detector Package Major Release x.x.x released on xx.xx.202x
|
|
===============================================================
|
|
|
|
This document describes the differences between vx.x.x and vx.0.2
|
|
|
|
|
|
|
|
CONTENTS
|
|
--------
|
|
1 New, Changed or Resolved Features
|
|
1.1 Compilation
|
|
1.2 Callback
|
|
1.3 Python
|
|
1.4 Client
|
|
1.5 Detector Server
|
|
1.6 Simulator
|
|
1.7 Receiver
|
|
1.8 Gui
|
|
2 On-board Detector Server Compatibility
|
|
3 Firmware Requirements
|
|
4 Kernel Requirements
|
|
5 Download, Documentation & Support
|
|
|
|
|
|
|
|
|
|
1 New, Changed or Resolved Features
|
|
=====================================
|
|
|
|
|
|
|
|
|
|
|
|
2 On-board Detector Server Compatibility
|
|
==========================================
|
|
|
|
|
|
Eiger 9.0.0
|
|
Jungfrau 9.0.0
|
|
Mythen3 9.0.0
|
|
Gotthard2 9.0.0
|
|
Moench 9.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/devdoc/serverupgrade.html
|
|
|
|
|
|
|
|
|
|
3 Firmware Requirements
|
|
========================
|
|
|
|
|
|
Eiger 02.10.2023 (v32) (updated in 7.0.3)
|
|
|
|
Jungfrau 20.09.2023 (v1.5, HW v1.0) (updated in 8.0.0)
|
|
21.09.2023 (v2.5, HW v2.0) (updated in 8.0.0)
|
|
|
|
Mythen3 11.10.2024 (v1.5) (updated in 9.0.0)
|
|
|
|
Gotthard2 03.10.2024 (v1.0) (updated in 9.0.0)
|
|
|
|
Moench 26.10.2023 (v2.0) (updated in 9.0.0)
|
|
|
|
|
|
Detector Upgrade
|
|
----------------
|
|
|
|
The following can be upgraded remotely:
|
|
|
|
Eiger via bit files
|
|
Jungfrau via command <.pof>
|
|
Mythen3 via command <.rbf>
|
|
Gotthard2 via command <.rbf>
|
|
Moench via 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/devdoc/firmware.html
|
|
|
|
|
|
|
|
|
|
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
|
|
---------------
|
|
Eiger via bit files
|
|
Others via command
|
|
|
|
Commands: udpatekernel, kernelversion
|
|
Instructions available at
|
|
https://slsdetectorgroup.github.io/devdoc/commandline.html
|
|
https://slsdetectorgroup.github.io/devdoc/detector.html
|
|
https://slsdetectorgroup.github.io/devdoc/pydetector.html
|
|
|
|
|
|
|
|
|
|
5 Download, Documentation & Support
|
|
====================================
|
|
|
|
Download
|
|
--------
|
|
|
|
The Source Code:
|
|
https://github.com/slsdetectorgroup/slsDetectorPackage
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Installation:
|
|
https://slsdetectorgroup.github.io/devdoc/installation.html
|
|
|
|
Quick Start Guide:
|
|
https://slsdetectorgroup.github.io/devdoc/quick_start_guide.html
|
|
|
|
Firmware Upgrade:
|
|
https://slsdetectorgroup.github.io/devdoc/firmware.html
|
|
|
|
Detector Server upgrade:
|
|
https://slsdetectorgroup.github.io/devdoc/serverupgrade.html
|
|
|
|
Detector Simulators:
|
|
https://slsdetectorgroup.github.io/devdoc/virtualserver.html
|
|
|
|
Consuming slsDetectorPackage:
|
|
https://slsdetectorgroup.github.io/devdoc/consuming.html
|
|
|
|
API Examples:
|
|
https://github.com/slsdetectorgroup/api-examples
|
|
|
|
Command Line Documentation:
|
|
https://slsdetectorgroup.github.io/devdoc/commandline.html
|
|
|
|
C++ API Documentation:
|
|
https://slsdetectorgroup.github.io/devdoc/detector.html
|
|
|
|
C++ API Example:
|
|
https://slsdetectorgroup.github.io/devdoc/examples.html#
|
|
|
|
Python API Documentation:
|
|
https://slsdetectorgroup.github.io/devdoc/pygettingstarted.html
|
|
|
|
Python API Example:
|
|
https://slsdetectorgroup.github.io/devdoc/pyexamples.html
|
|
|
|
Receivers (including custom receiver):
|
|
https://slsdetectorgroup.github.io/devdoc/receivers.html
|
|
https://slsdetectorgroup.github.io/devdoc/slsreceiver.html
|
|
|
|
Detector UDP Header:
|
|
https://slsdetectorgroup.github.io/devdoc/udpheader.html
|
|
https://slsdetectorgroup.github.io/devdoc/udpdetspec.html
|
|
|
|
slsReceiver Zmq Format:
|
|
https://slsdetectorgroup.github.io/devdoc/slsreceiver.html#zmq-json-header-format
|
|
|
|
TroubleShooting:
|
|
https://slsdetectorgroup.github.io/devdoc/troubleshooting.html
|
|
https://slsdetectorgroup.github.io/devdoc/troubleshooting.html#receiver-pc-tuning-options
|
|
|
|
Further Documentation:
|
|
https://www.psi.ch/en/detectors/documentation
|
|
|
|
Info on Releases:
|
|
https://www.psi.ch/en/detectors/software
|
|
|
|
|
|
Support
|
|
-------
|
|
|
|
dhanya.thattil@psi.ch
|
|
erik.frojdh@psi.ch
|