detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-24 10:31:09 +02:00
Code Issues Actions Packages Releases Activity

update doc

Browse Source
This commit is contained in:
maliakal_d
2020-11-17 16:45:19 +01:00
parent 2fa3ebd8e6
commit 5142603103
1 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
RELEASE.txt
View File

@ -20,6 +20,7 @@ SLS Detector Package 5.0.0 released on xx.xx.2020 (Major Release)
- Scans (dacs and trimbit) - Scans (dacs and trimbit)
- Timing commands - Timing commands
- Enum list (daclist, dacvalues, settingslist, drlist etc.) - Enum list (daclist, dacvalues, settingslist, drlist etc.)
- Command line (return code)
- Command line (dac) - Command line (dac)
- Detector Simulators - Detector Simulators
- Zmq interface (ZmqSocket.h) - Zmq interface (ZmqSocket.h)
@ -83,6 +84,15 @@ SLS Detector Package 5.0.0 released on xx.xx.2020 (Major Release)
sls_detector_exceptions.h sls_detector_exceptions.h
Make sure you catch all exceptions in custom gui and handle them or Make sure you catch all exceptions in custom gui and handle them or
inform the user. inform the user.
Exceptions thrown in callbacks are also handled.
- An exception in startAcquisitionCallBack will need to be handled in
startReceiver or acquire()
- An exception in acquisitionFinishedCallBack will need to be handled in
stopReceiver or acquire()
- An exception in rawDataReadyCallBack or rawDataModifyReadyCallBack
will only print and skip image to free it in memory. If address is
incorrect after callback, expect undefined behavior.
5. Scans 5. Scans
One can do scans for dacs or trimbits. Trimbits are only for Eiger or One can do scans for dacs or trimbits. Trimbits are only for Eiger or
@ -101,16 +111,20 @@ SLS Detector Package 5.0.0 released on xx.xx.2020 (Major Release)
the detector in shared memory. the detector in shared memory.
eg. daclist, settingslist, drlist, timinglist, templist eg. daclist, settingslist, drlist, timinglist, templist
Command line also has commands to get their values. Command line also has commands to get their values.
eg. dacvalues, tempvalues, eg. dacvalues, tempvalues
8. Command Line (Dac) 8. Command Line (return code)
Return code of the client command line applications now return 0 for
success and 1 for failure.
9. Command Line (Dac)
All dac commands have been converted to a single "dac" command with All dac commands have been converted to a single "dac" command with
the previous dac commands as arguments. the previous dac commands as arguments.
eg. sls_detector_get vcmp_ll eg. sls_detector_get vcmp_ll
is now is now
sls_detector_get dac vcmp_ll sls_detector_get dac vcmp_ll
9. UDP Configuration 10. UDP Configuration
Once all the udp details are set in the detector, the detector's Once all the udp details are set in the detector, the detector's
destination is then configured automatically. If the detector is not destination is then configured automatically. If the detector is not
configured, it will fail when acquiring. If any of these parameters configured, it will fail when acquiring. If any of these parameters
@ -119,7 +133,7 @@ SLS Detector Package 5.0.0 released on xx.xx.2020 (Major Release)
udp_validate (to validate if it has been configured) and udp_validate (to validate if it has been configured) and
udp_reconfigure (to reconfigure). udp_reconfigure (to reconfigure).
10. Gap Pixels 11. Gap Pixels
Gap pixels are now only available in client call back or gui (not in Gap pixels are now only available in client call back or gui (not in
receiver anymore). It can be enabled for Eiger and Jungfrau and receiver anymore). It can be enabled for Eiger and Jungfrau and
includes inter chip and inter module gap pixels. includes inter chip and inter module gap pixels.