| ... | ... | @@ -66,22 +66,12 @@ The `dataPackage` that the RTIS Network Server sends contains a tuple with the f |
|
|
|
- `index`: int: The measurement index of this measurement for this RTIS Client.
|
|
|
|
- `behaviour`: int (0 or 1): The behaviour of the RTIS Client sonar mode. 0 means passive, 1 means active.
|
|
|
|
|
|
|
|
<table class="docutils field-list field-table" frame="void" rules="none">
|
|
|
|
<col class="field-name" />
|
|
|
|
<col class="field-body" />
|
|
|
|
<tbody valign="top">
|
|
|
|
|
|
|
|
</tbody>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# **Classes**
|
|
|
|
|
|
|
|
## **RTISClientObj**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>class</i> <b>RTISClientObj</b>(<i>client_id, client_ip, network_version, firmware_version, client_online=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L82">[source]</a>
|
|
|
|
<i>class</i> <b>RTISClientObj</b>(<i>client_id, client_ip, network_version, firmware_version, client_online=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L83">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
Class describing a connected RTIS Client.
|
| ... | ... | @@ -147,7 +137,7 @@ Class describing a connected RTIS Client. |
|
|
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i></i> <b>update_heartbeat</b>(<i>self, client_ip, client_configured, client_behaviour, client_inputDataQueueSize, client_outputDataQueueSize, client_internalCounter</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L166">[source]</a>
|
|
|
|
<i></i> <b>update_heartbeat</b>(<i>self, client_ip, client_configured, client_behaviour, client_inputDataQueueSize, client_outputDataQueueSize, client_internalCounter</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L167">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
Method that is used by RTIS Server to update the status of a RTIS Client when a new heartbeat is received.
|
| ... | ... | @@ -191,7 +181,7 @@ Method that is used by RTIS Server to update the status of a RTIS Client when a |
|
|
|
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i></i> <b>check_heartbeat</b>(<i>self, maximum_delta=15</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L204">[source]</a>
|
|
|
|
<i></i> <b>check_heartbeat</b>(<i>self, maximum_delta=15</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L205">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
Method to check if a RTIS Client has timed out based on a check of it's previous received heartbeat.
|
| ... | ... | @@ -222,7 +212,7 @@ Method to check if a RTIS Client has timed out based on a check of it's previous |
|
|
|
## **Pose**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>class</i> <b>Pose</b>(<i>x, y, z, pitch, yaw, roll</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L228">[source]</a>
|
|
|
|
<i>class</i> <b>Pose</b>(<i>x, y, z, pitch, yaw, roll</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L229">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
Class describing a 3D pose using the right-handed coordinate system where x points forward, Y points to the left
|
| ... | ... | @@ -271,7 +261,7 @@ x, y and z are in meters. Pitch, yaw and roll in degrees. |
|
|
|
## **dspSettings**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>class</i> <b>dspSettings</b>(<i>configName, dspFiles, workers, pdmEnable, matchedFilterEnable, beamformingEnable, enveloppeEnable, cleanEnable, version</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L298">[source]</a>
|
|
|
|
<i>class</i> <b>dspSettings</b>(<i>configName, dspFiles, workers, pdmEnable, matchedFilterEnable, beamformingEnable, enveloppeEnable, cleanEnable, version</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L299">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
Class describing all the recording and processing settings related to RTIS devices.
|
| ... | ... | @@ -284,7 +274,6 @@ Can be converted to a dictionary. |
|
|
|
<col class="field-body" />
|
|
|
|
<tbody valign="top">
|
|
|
|
|
|
|
|
</tbody>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
| ... | ... | @@ -296,7 +285,7 @@ Can be converted to a dictionary. |
|
|
|
## **dsp_worker_process**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>def</i> <b>dsp_worker_process</b>(<i>dspSettings, inputDataQueue, outputDataQueue, logger =None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L457">[source]</a>
|
|
|
|
<i>def</i> <b>dsp_worker_process</b>(<i>dspSettings, inputDataQueue, outputDataQueue, logger =None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L458">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
The method to use als a `multiprocessing.Process` to perform a DSP pipeline on sonar measurements
|
| ... | ... | @@ -344,7 +333,7 @@ The resulting data on the output data queue will be a tuple with the following c |
|
|
|
## **get_server_config**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>def</i> <b>get_server_config</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L525">[source]</a>
|
|
|
|
<i>def</i> <b>get_server_config</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L526">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
A method to connect to the RTIS Server and get the [`dspSettings`](https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/wikis/home#dspsettings) currently used by the RTIS Server.
|
| ... | ... | @@ -380,7 +369,7 @@ Usefull for connected applications. |
|
|
|
## **get_clients_and_configs**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>def</i> <b>get_clients_and_configs</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L601">[source]</a>
|
|
|
|
<i>def</i> <b>get_clients_and_configs</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L602">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
A method to connect to the RTIS Server and get all the active connected RTIS Clients
|
| ... | ... | @@ -417,7 +406,7 @@ Usefull for connected applications. |
|
|
|
## **get_client_pose**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>def</i> <b>get_client_pose</b>(<i>serverIp, client_id, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L697">[source]</a>
|
|
|
|
<i>def</i> <b>get_client_pose</b>(<i>serverIp, client_id, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L698">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
A method to connect to the RTIS Server and get the [`Pose`](https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/wikis/home#pose) of a particular RTIS Client with.
|
| ... | ... | @@ -457,7 +446,7 @@ Usefull for connected applications. |
|
|
|
## **set_behaviour_active**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>def</i> <b>set_behaviour_active</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L746">[source]</a>
|
|
|
|
<i>def</i> <b>set_behaviour_active</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L747">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to active.
|
| ... | ... | @@ -486,7 +475,7 @@ Usefull for connected applications. |
|
|
|
## **set_behaviour_passive**
|
|
|
|
|
|
|
|
<p class="func-header">
|
|
|
|
<i>def</i> <b>set_behaviour_passive</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L773">[source]</a>
|
|
|
|
<i>def</i> <b>set_behaviour_passive</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/blob/master/rtiscommon/RTISCommon2.py#L774">[source]</a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to passive.
|
| ... | ... | |
