mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-05-07 21:30:05 +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
147 lines
6.0 KiB
ReStructuredText
147 lines
6.0 KiB
ReStructuredText
.. _detector udp header:
|
|
|
|
Format
|
|
=======
|
|
|
|
The UDP data format for the packets consist of a common header of 48 bytes for all detectors, followed by the data for that one packet.
|
|
|
|
|
|
Current Version
|
|
---------------------------
|
|
|
|
**v2.0 (slsDetectorPackage v7.0.0+)**
|
|
|
|
.. code-block:: cpp
|
|
|
|
typedef struct {
|
|
uint64_t frameNumber;
|
|
uint32_t expLength;
|
|
uint32_t packetNumber;
|
|
uint64_t detSpec1;
|
|
uint64_t timestamp;
|
|
uint16_t modId;
|
|
uint16_t row;
|
|
uint16_t column;
|
|
uint16_t detSpec2;
|
|
uint32_t detSpec3;
|
|
uint16_t detSpec4;
|
|
uint8_t detType;
|
|
uint8_t version;
|
|
} sls_detector_header;
|
|
|
|
|
|
.. table:: <---------------------------------------------------- 8 bytes per row --------------------------------------------->
|
|
:align: center
|
|
:widths: 30,30,30,15,15
|
|
|
|
+---------------------------------------------------------------+
|
|
| frameNumber |
|
|
+-------------------------------+-------------------------------+
|
|
| expLength | packetNumber |
|
|
+-------------------------------+-------------------------------+
|
|
| **detSpec1** |
|
|
+---------------------------------------------------------------+
|
|
| timestamp |
|
|
+---------------+---------------+---------------+---------------+
|
|
| modId | row | column | **detSpec2** |
|
|
+---------------+---------------+---------------+-------+-------+
|
|
| **detSpec3** | **detSpec4** |detType|version|
|
|
+-------------------------------+---------------+-------+-------+
|
|
|
|
|
|
.. note ::
|
|
|
|
Since there is no difference in the format of the UDP header from the detector
|
|
from the previous version (v2.0), the version number stays the same.
|
|
|
|
Only the struture member names have changed in sls_detector_defs.h
|
|
|
|
|
|
|
|
Description
|
|
------------
|
|
|
|
* **Detector specific field** descriptions are found :ref:`here<detector specific fields>`.
|
|
|
|
* **frameNumber**: framenumber to which the current packet belongs to.
|
|
|
|
* **expLength**: measured exposure time of the frame in tenths of microsecond. It is instead the sub frame number for Eiger.
|
|
|
|
* **packetNumber**: packet number of the frame to which the current data belongs to.
|
|
|
|
* **timestamp**: time measured at the start of frame exposure since the start of the current measurement. It is expressed in tenths of microsecond.
|
|
|
|
* **modId**: module ID picked up from det_id_[detector type].txt on the detector cpu.
|
|
|
|
* **row**: row position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
|
|
|
|
* **column**: column position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
|
|
|
|
* **detType**: detector type from enum of detectorType in the package.
|
|
|
|
* **version**: current version of the detector header (0x2).
|
|
|
|
|
|
.. _detector enum:
|
|
|
|
Detector Enum
|
|
--------------
|
|
|
|
================ ========
|
|
Detector Type Value
|
|
================ ========
|
|
GENERIC 0
|
|
EIGER 1
|
|
GOTTHARD* 2
|
|
JUNGFRAU 3
|
|
CHIPTESTBOARD 4
|
|
MOENCH 5
|
|
MYTHEN3 6
|
|
GOTTHARD2 7
|
|
================ ========
|
|
* deprecated since v10.0.0
|
|
|
|
|
|
Previous Versions
|
|
-----------------
|
|
**v2.0 (Package v4.0.0 - 6.x.x)**
|
|
|
|
.. table:: <---------------------------------------------------- 8 bytes ---------------------------------------------------->
|
|
:align: center
|
|
:widths: 30,30,30,15,15
|
|
|
|
+---------------------------------------------------------------+
|
|
| frameNumber |
|
|
+-------------------------------+-------------------------------+
|
|
| expLength | packetNumber |
|
|
+-------------------------------+-------------------------------+
|
|
| bunchid |
|
|
+---------------------------------------------------------------+
|
|
| timestamp |
|
|
+---------------+---------------+---------------+---------------+
|
|
| modId | **row** | **column** | **reserved** |
|
|
+---------------+---------------+---------------+-------+-------+
|
|
| debug | roundRNumber |detType|version|
|
|
+-------------------------------+---------------+-------+-------+
|
|
|
|
**v1.0 (Package v3.0.0 - 3.1.5)**
|
|
|
|
.. table:: <---------------------------------------------------- 8 bytes ---------------------------------------------------->
|
|
:align: center
|
|
:widths: 30,30,30,15,15
|
|
|
|
+---------------------------------------------------------------+
|
|
| frameNumber |
|
|
+-------------------------------+-------------------------------+
|
|
| expLength | packetNumber |
|
|
+-------------------------------+-------------------------------+
|
|
| bunchid |
|
|
+---------------------------------------------------------------+
|
|
| timestamp |
|
|
+---------------+---------------+---------------+---------------+
|
|
| modId | xCoord | yCoord | zCoord |
|
|
+---------------+---------------+---------------+-------+-------+
|
|
| debug | roundRNumber |detType|version|
|
|
+-------------------------------+---------------+-------+-------+
|
|
|