mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-11-13 22:03:53 +01:00
Update Documentation for developer
This commit is contained in:
1 parent
cae18608af
commit
3857d8e0ae
8 files changed
+21
-12
No files matched your search
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -1142,7 +1142,7 @@ Also changes clkdiv 2, 3, 4</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="slsdet.Ctb.chipversion">
|
||||
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">chipversion</span></span><a class="headerlink" href="#slsdet.Ctb.chipversion" title="Link to this definition"></a></dt>
|
||||
<dd><p>[Jungfrau] Chip version of module. Can be 1.0 or 1.1.</p>
|
||||
<dd><p>[Jungfrau] Chip version of module. Can be 1.0, 1.1 or 1.2.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">chipversion</span>
|
||||
<span class="go">'1.0'</span>
|
||||
|
||||
@@ -1133,7 +1133,7 @@ Also changes clkdiv 2, 3, 4</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="slsdet.Detector.chipversion">
|
||||
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">chipversion</span></span><a class="headerlink" href="#slsdet.Detector.chipversion" title="Link to this definition"></a></dt>
|
||||
<dd><p>[Jungfrau] Chip version of module. Can be 1.0 or 1.1.</p>
|
||||
<dd><p>[Jungfrau] Chip version of module. Can be 1.0, 1.1 or 1.2.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">chipversion</span>
|
||||
<span class="go">'1.0'</span>
|
||||
|
||||
@@ -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
|
||||
@@ -1673,10 +1673,10 @@
|
||||
<td><p>0x171220</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>REQRD_FRMWRE_VRSN_BOARD2</p></td>
|
||||
<td><p>0x250209</p></td>
|
||||
<td><p>0x260814</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>REQRD_FRMWRE_VRSN</p></td>
|
||||
<td><p>0x250208</p></td>
|
||||
<td><p>0x260813</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>NUM_HARDWARE_VERSIONS</p></td>
|
||||
<td><p>2</p></td>
|
||||
@@ -1847,7 +1847,7 @@
|
||||
<td><p>3</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>MAX_STORAGE_CELL_DLY_NS_VAL</p></td>
|
||||
<td><p>ASIC_CTRL_EXPSRE_TMR_MAX_VAL</p></td>
|
||||
<td><p>STORAGE_CELL_EXPSRE_TMR_MAX_VAL</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>ACQ_TIME_MIN_CLOCK</p></td>
|
||||
<td><p>2</p></td>
|
||||
@@ -1978,22 +1978,31 @@
|
||||
<tr class="row-even"><td><p>UDP_IP_HEADER_LENGTH_BYTES</p></td>
|
||||
<td><p>28</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>MASTER_NAMES</p></td>
|
||||
<tr class="row-odd"><td><p>CHIP_VALS</p></td>
|
||||
<td><p>{10, 11, 120, 121, 122, 13};</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>CHIP_VALS_HELP</p></td>
|
||||
<td><p>10, 11, 120, 121, 122, 13</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>CHIP_NAMES</p></td>
|
||||
<td><p>v1.0, v1.1, v1.2 Normal, v1.2 Low Noise, v1.2 HDR, v1.3 Burst Mode</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>MASTER_NAMES</p></td>
|
||||
<td><p>hardware, master, slave</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>NUMSETTINGS</p></td>
|
||||
<tr class="row-odd"><td><p>NUMSETTINGS</p></td>
|
||||
<td><p>2</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>NSPECIALDACS</p></td>
|
||||
<tr class="row-even"><td><p>NSPECIALDACS</p></td>
|
||||
<td><p>3</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SPECIALDACINDEX</p></td>
|
||||
<tr class="row-odd"><td><p>SPECIALDACINDEX</p></td>
|
||||
<td><p>{J_VREF_PRECH, J_VREF_DS, J_VREF_COMP};</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>SPECIAL_DEFAULT_DYNAMIC_GAIN_VALS</p></td>
|
||||
<tr class="row-even"><td><p>SPECIAL_DEFAULT_DYNAMIC_GAIN_VALS</p></td>
|
||||
<td><p>{ 1450, 480, 420 }</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>SPECIAL_DEFAULT_DYNAMICHG0_GAIN_VALS</p></td>
|
||||
<tr class="row-odd"><td><p>SPECIAL_DEFAULT_DYNAMICHG0_GAIN_VALS</p></td>
|
||||
<td><p>{ 1550, 450, 620 }</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
Reference in new issue
Block a user