Update Documentation for developer

This commit is contained in:
github-actions committed 2026-05-21 08:25:33 +00:00
1 parent e6e1cca410
commit d8a26be0fa
4 files changed
+3 -3

No files matched your search

Binary file not shown.
Binary file not shown.
+2 -2
View File
@@ -429,7 +429,7 @@
</div>
</dd>
<dt id="term-counters-i0-i1-i2-...">counters [i0] [i1] [i2]…<a class="headerlink" href="#term-counters-i0-i1-i2-..." title="Link to this term"></a></dt><dd><div class="line-block">
<div class="line">[Mythen3] List of counters indices enabled. Each element in list can be 0 - 2 and must be non repetitive. Enabling counters sets vth dacs to remembered values and disabling sets them to disabled values.</div>
<div class="line">[Mythen3] List of counters indices enabled, support both comma and/or space separation. Each element in list can be 0 - 2 and must be non repetitive. Enabling counters sets vth dacs to remembered values and disabling sets them to disabled values.</div>
</div>
</dd>
<dt id="term-currentsource">currentsource<a class="headerlink" href="#term-currentsource" title="Link to this term"></a></dt><dd><div class="line-block">
@@ -1203,7 +1203,7 @@
</div>
</dd>
<dt id="term-rx_dbitlist-all-or-none-or-i0-i1-i2-...">rx_dbitlist [all] or [none] or [i0] [i1] [i2]…<a class="headerlink" href="#term-rx_dbitlist-all-or-none-or-i0-i1-i2-..." title="Link to this term"></a></dt><dd><div class="line-block">
<div class="line">[Ctb] List of digital signal bits enabled and rearranged according to the signals (all samples of each signal is put together). If ‘all’ is used instead of a list, all digital bits (64) enabled. Each element in list can be 0 - 63 and must be non repetitive. The option ‘none’ will still spit out all data as is from the detector, but without rearranging it. Please note that when using the receiver list, the data size will be bigger if the number of samples is not divisible by 8 as every signal bit is padded to the next byte when combining all the samples in the receiver.</div>
<div class="line">[Ctb] List of digital signal bits enabled and rearranged according to the signals (all samples of each signal is put together). Support both comma and/or space separation. If ‘all’ is used instead of a list, all digital bits (64) enabled. Each element in list can be 0 - 63 and must be non repetitive. The option ‘none’ will still spit out all data as is from the detector, but without rearranging it. Please note that when using the receiver list, the data size will be bigger if the number of samples is not divisible by 8 as every signal bit is padded to the next byte when combining all the samples in the receiver.</div>
</div>
</dd>
<dt id="term-rx_dbitoffset-n_bytes">rx_dbitoffset [n_bytes]<a class="headerlink" href="#term-rx_dbitoffset-n_bytes" title="Link to this term"></a></dt><dd><div class="line-block">
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[25,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[25,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[24,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[21,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[22,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detector-index"]],"Detector status is waiting even in auto timLine truncated
Search.setIndex({"alltitles":{"$SLSDETNAME":[[18,"slsdetname"]],"1. Install pre-built binaries using conda (Recommended)":[[16,"install-pre-built-binaries-using-conda-recommended"]],"1. Total Failure of Packet Delivery":[[37,"total-failure-of-packet-delivery"]],"1GbE/ 10GbE Interfaces":[[8,"gbe-10gbe-interfaces"],[8,"id29"]],"2. Partial or Random Packet Loss (Performance)":[[37,"partial-or-random-packet-loss-performance"]],"2. Pip":[[16,"pip"]],"3. Build from source":[[16,"build-from-source"]],"3.1. Download Source Code from github":[[16,"download-source-code-from-github"]],"3.2. Build from Source":[[16,"build-from-source-using-cmake"]],"3.2.1. Build using CMake":[[16,"build-using-cmake"]],"3.2.2. Build using in-built cmk.sh script":[[16,"build-using-in-built-cmk-sh-script"]],"3.3. Build on old distributions using conda":[[16,"build-on-old-distributions-using-conda"]],"3.4. Build slsDetectorGui (Qt5)":[[16,"build-slsdetectorgui-qt5"]],"3.5. Build this documentation":[[16,"build-this-documentation"]],"4. Pybind and Zeromq":[[16,"pybind-and-zeromq"]],"5.0.0 - 6.1.1":[[33,"id1"]],"6.1.1+ (no tftp required)":[[33,"no-tftp-required"]],"< 5.0.0":[[33,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes per row \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014>":[[41,"id2"]],"<\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014- 8 bytes \u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014->":[[41,"id3"],[41,"id4"]],"Accessing individual modules":[[25,"accessing-individual-modules"]],"Arguments":[[32,"arguments"],[42,"arguments"]],"Autocompletion":[[4,"autocompletion"]],"Automatic start":[[32,"automatic-start"]],"Binaries":[[42,"binaries"]],"Binary File Format":[[3,null]],"Building from Source":[[25,"building-from-source"]],"C++ API":[[15,null]],"CATCH2 Tests":[[0,"catch2-tests"]],"CMake: find_package and conda":[[6,"cmake-find-package-and-conda"]],"CMake: find_package(slsDetectorPackage)":[[6,"cmake-find-package-slsdetectorpackage"]],"CMake: slsDetectorPackage as submodule in your project":[[6,"cmake-slsdetectorpackage-as-submodule-in-your-project"]],"Cannot connect to detector":[[37,"cannot-connect-to-detector"]],"Cannot connect to receiver":[[37,"cannot-connect-to-receiver"]],"Cannot get data without a module attached":[[37,"cannot-get-data-without-a-module-attached"]],"Cannot get multi module data":[[37,"cannot-get-multi-module-data"],[37,"jungfrau-troubleshooting-power-supply"]],"Cannot ping module (Nios)":[[37,"cannot-ping-module-nios"]],"Cannot stop slaves in sync mode":[[37,"cannot-stop-slaves-in-sync-mode"]],"Checking for other detectors":[[18,"checking-for-other-detectors"]],"Chip Test Board":[[3,"chip-test-board"],[17,"chip-test-board"]],"Client":[[27,"client"],[36,"client"],[42,"client"]],"Client Commands":[[34,"client-commands"]],"Client to Module":[[5,"client-to-module"]],"Client to Receiver":[[5,"client-to-receiver"]],"Command Execution":[[4,"command-execution"]],"Command line":[[15,null]],"Command line interface":[[4,null]],"Commands":[[4,"commands"]],"Common":[[37,"common"]],"Compilation":[[14,"compilation"],[42,"compilation"]],"Compile examples":[[11,"compile-examples"]],"Config file":[[39,null]],"Consuming slsDetectorPackage":[[6,null]],"ContainerUtils":[[7,null]],"Content":[[12,"content"]],"Converting numbers to hex":[[24,"converting-numbers-to-hex"]],"Core":[[9,"core"]],"Counters":[[8,"counters"]],"Ctb":[[13,"ctb"],[21,null],[31,"ctb"]],"Current Version":[[41,"current-version"]],"Custom Receiver":[[29,null]],"DACS":[[31,"dacs"],[31,"id1"],[31,"id2"],[31,"id3"],[31,"id4"]],"DAQ Info Field":[[40,"id10"]],"Data":[[27,"data"]],"Data File":[[3,"data-file"],[14,"data-file"]],"Default Configuration":[[8,"default-configuration"],[8,"id25"],[8,"id33"]],"Default Values":[[31,null]],"Default values":[[31,"id5"],[31,"id7"],[31,"id9"],[31,"id11"],[31,"id12"],[31,"id14"]],"Dependencies":[[9,null]],"Dependencies to build GUI":[[9,"dependencies-to-build-gui"]],"Dependencies to build Moench and Jungfrau executables":[[9,"dependencies-to-build-moench-and-jungfrau-executables"]],"Dependencies to build Python module":[[9,"dependencies-to-build-python-module"]],"Dependencies to build Tests":[[9,"dependencies-to-build-tests"]],"Dependencies to build documentation":[[9,"dependencies-to-build-documentation"]],"Deprecated commands":[[4,"deprecated-commands"],[4,"id1"]],"Description":[[41,"description"]],"Detector":[[10,null],[22,null],[27,"detector"]],"Detector Enum":[[41,"detector-enum"]],"Detector Image Size and Format":[[8,null]],"Detector Server":[[15,null]],"Detector Specific Field":[[40,"id8"],[40,"id9"],[40,"id11"],[40,"id12"]],"Detector Specific Fields":[[40,null]],"Detector UDP Header":[[15,null]],"Detector index":[[4,"detector-index"],[18,"detector-index"]],"Detector status is waiting even in auto timLine truncated