detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-18 07:47:12 +02:00
Code Issues Actions Packages Releases Activity

command line doc. done

Browse Source
This commit is contained in:
Dhanya Maliakal
2017-08-17 17:08:55 +02:00
parent e2af1de83f
commit e0c29190a2
17 changed files with 345 additions and 290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
manual/slsDetectorClientDocs/html/receiver.html
View File

@ -40,34 +40,34 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<h1><a class="anchor" id="receiver">Receiver commands </a></h1><p>Commands to configure the receiver. Not used in MYTHEN.</p>
<ul>
<li><b>receiver [s]</b> starts/stops the receiver to listen to detector packets. Gets status of receiver. Options: [start, stop].</li>
<li><b>receiver [s]</b> starts/stops the receiver to listen to detector packets. Options: [ <code>start</code>, <code>stop</code>]. <code>Returns</code> <code></code>(string) status of receiver[ <code>idle</code>, <code>running</code>].</li>
</ul>
<ul>
<li><b>r_online [i]</b> sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory.</li>
<li><b>r_online [i]</b> sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory. <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>r_checkonline</b> Checks the receiver if it is online/offline mode. Prints either 'All receiver online', '[List of all receiver hostname in offline mode] :Not all receiver online'. Only get!</li>
<li><b>r_checkonline</b> Checks the receiver if it is online/offline mode. Only get! <code>Returns</code> (string) "All online" or "[list of offline hostnames] : Not online".</li>
</ul>
<ul>
<li><b>framescaught</b> gets the number of frames caught by receiver. Average of all for multi-detector command. Only get!</li>
<li><b>framescaught</b> gets the number of frames caught by receiver. Average of all for multi-detector command. Only get! <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>resetframescaught [i]</b> resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put!</li>
<li><b>resetframescaught [i]</b> resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put! <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>frameindex [i]</b> gets the current frame index of receiver. Average of all for multi-detector command. Only get!</li>
<li><b>frameindex [i]</b> gets the current frame index of receiver. Average of all for multi-detector command. Only get! <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>r_lock [i]</b> locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks.</li>
<li><b>r_lock [i]</b> locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks. <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>r_lastclient</b> gets the last client communicating with the receiver. Only get!</li>
<li><b>r_lastclient</b> gets the last client communicating with the receiver. Only get! <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>r_readfreq [i]</b> sets/gets the stream frequency of data from receiver to client. i &gt; 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms).</li>
<li><b>r_readfreq [i]</b> sets/gets the stream frequency of data from receiver to client. i &gt; 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms). <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>rx_fifodepth [i]</b> sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss, not if limited by writing. </li>
<li><b>rx_fifodepth [i]</b> sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss (loss due to packet processing time in Listener threads), not if limited by writing. <code>Returns</code> <code></code>(int) </li>
</ul>
</div>
<!--- window showing the filter options -->