Skip to content

GitLab

Home · Changes

Page history
Update home authored by Wouter Jansen's avatar Wouter Jansen
Show whitespace changes
Inline Side-by-side
home.md
View page @ 1d1c0d9f
...@@ -71,7 +71,7 @@ The `dataPackage` that the RTIS Network Server sends contains a tuple with the f ...@@ -71,7 +71,7 @@ The `dataPackage` that the RTIS Network Server sends contains a tuple with the f
## **RTISClientObj** ## **RTISClientObj**
<p class="func-header"> <p class="func-header">
<i>class</i> <b>RTISClientObj</b>(<i>client_id, client_ip, network_version, firmware_version, required, client_online=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L83">[source]</a> <i>class</i> <b>RTISClientObj</b>(<i>client_id, client_ip, network_version, firmware_version, required, client_online=True</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/RTISCommon.py#L83">[source]</a>
</p> </p>
Class describing a connected RTIS Client. Class describing a connected RTIS Client.
...@@ -149,7 +149,7 @@ Class describing a connected RTIS Client. ...@@ -149,7 +149,7 @@ Class describing a connected RTIS Client.
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L190">[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/rtiscommon/-/blob/master/RTISCommon.py#L190">[source]</a>
</p> </p>
Method that is used by RTIS Server to update the status of a RTIS Client when a new heartbeat is received. Method that is used by RTIS Server to update the status of a RTIS Client when a new heartbeat is received.
...@@ -193,7 +193,7 @@ Method that is used by RTIS Server to update the status of a RTIS Client when a ...@@ -193,7 +193,7 @@ Method that is used by RTIS Server to update the status of a RTIS Client when a
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L226">[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/rtiscommon/-/blob/master/RTISCommon.py#L226">[source]</a>
</p> </p>
Method to check if a RTIS Client has timed out based on a check of it's previous received heartbeat. Method to check if a RTIS Client has timed out based on a check of it's previous received heartbeat.
...@@ -224,7 +224,7 @@ Method to check if a RTIS Client has timed out based on a check of it's previous ...@@ -224,7 +224,7 @@ Method to check if a RTIS Client has timed out based on a check of it's previous
<p class="func-header"> <p class="func-header">
<i></i> <b>check_stability</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L249">[source]</a> <i></i> <b>check_stability</b>(<i>self</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/RTISCommon.py#L249">[source]</a>
</p> </p>
Method to check if a RTIS Client is in the 'ready' configuration state for at least 1 minute Method to check if a RTIS Client is in the 'ready' configuration state for at least 1 minute
...@@ -249,7 +249,7 @@ to indicate it is fully ready and stable for operation. ...@@ -249,7 +249,7 @@ to indicate it is fully ready and stable for operation.
## **Pose** ## **Pose**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L278">[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/rtiscommon/-/blob/master/RTISCommon.py#L278">[source]</a>
</p> </p>
Class describing a 3D pose using the right-handed coordinate system where x points forward, Y points to the left Class describing a 3D pose using the right-handed coordinate system where x points forward, Y points to the left
...@@ -298,7 +298,7 @@ x, y and z are in meters. Pitch, yaw and roll in degrees. ...@@ -298,7 +298,7 @@ x, y and z are in meters. Pitch, yaw and roll in degrees.
## **dspSettings** ## **dspSettings**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L348">[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/rtiscommon/-/blob/master/RTISCommon.py#L348">[source]</a>
</p> </p>
Class describing all the recording and processing settings related to RTIS devices. Class describing all the recording and processing settings related to RTIS devices.
...@@ -322,7 +322,7 @@ Can be converted to a dictionary. ...@@ -322,7 +322,7 @@ Can be converted to a dictionary.
## **dsp_worker_process** ## **dsp_worker_process**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L507">[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/rtiscommon/-/blob/master/RTISCommon.py#L507">[source]</a>
</p> </p>
The method to use als a `multiprocessing.Process` to perform a DSP pipeline on sonar measurements The method to use als a `multiprocessing.Process` to perform a DSP pipeline on sonar measurements
...@@ -370,7 +370,7 @@ The resulting data on the output data queue will be a tuple with the following c ...@@ -370,7 +370,7 @@ The resulting data on the output data queue will be a tuple with the following c
## **get_server_config** ## **get_server_config**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L575">[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/rtiscommon/-/blob/master/RTISCommon.py#L575">[source]</a>
</p> </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. 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.
...@@ -406,7 +406,7 @@ Usefull for connected applications. ...@@ -406,7 +406,7 @@ Usefull for connected applications.
## **get_clients_and_configs** ## **get_clients_and_configs**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L651">[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/rtiscommon/-/blob/master/RTISCommon.py#L651">[source]</a>
</p> </p>
A method to connect to the RTIS Server and get all the active connected RTIS Clients A method to connect to the RTIS Server and get all the active connected RTIS Clients
...@@ -443,7 +443,7 @@ Usefull for connected applications. ...@@ -443,7 +443,7 @@ Usefull for connected applications.
## **get_client_pose** ## **get_client_pose**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L747">[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/rtiscommon/-/blob/master/RTISCommon.py#L747">[source]</a>
</p> </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. 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.
...@@ -483,7 +483,7 @@ Usefull for connected applications. ...@@ -483,7 +483,7 @@ Usefull for connected applications.
## **set_behaviour_active** ## **set_behaviour_active**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L796">[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/rtiscommon/-/blob/master/RTISCommon.py#L796">[source]</a>
</p> </p>
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to active. A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to active.
...@@ -512,7 +512,7 @@ Usefull for connected applications. ...@@ -512,7 +512,7 @@ Usefull for connected applications.
## **set_behaviour_passive** ## **set_behaviour_passive**
<p class="func-header"> <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/rtiscommon/-/blob/master/rtiscommon/RTISCommon.py#L823">[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/rtiscommon/-/blob/master/RTISCommon.py#L823">[source]</a>
</p> </p>
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to passive. A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to passive.
......