Skip to content

GitLab

Home · Changes

Page history
Update home authored by Wouter Jansen's avatar Wouter Jansen
Hide whitespace changes
Inline Side-by-side
home.md
View page @ eef7e486
...@@ -9,6 +9,12 @@ ...@@ -9,6 +9,12 @@
- [get_server_config](#get_server_config) - [get_server_config](#get_server_config)
- [get_clients_and_configs](#get_clients_and_configs) - [get_clients_and_configs](#get_clients_and_configs)
- [get_client_pose](#get_client_pose) - [get_client_pose](#get_client_pose)
- [reload_config](#reload_config)
- [prepare](#prepare)
- [idle](#idle)
- [stop](#stop)
- [start](#start)
- [set_counter](#set_counter)
- [set_behaviour_active](#set_behaviour_active) - [set_behaviour_active](#set_behaviour_active)
- [set_behaviour_passive](#set_behaviour_passive) - [set_behaviour_passive](#set_behaviour_passive)
...@@ -316,7 +322,7 @@ The resulting data on the output data queue will be a tuple with the following c ...@@ -316,7 +322,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.py#L604">[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#L605">[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.
...@@ -352,7 +358,7 @@ Useful for connected applications. ...@@ -352,7 +358,7 @@ Useful 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.py#L681">[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#L682">[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
...@@ -376,7 +382,7 @@ Useful for connected applications. ...@@ -376,7 +382,7 @@ Useful for connected applications.
</tr> </tr>
<tr class="field"> <tr class="field">
<th class="field-name"><b>Returns:</b></td> <th class="field-name"><b>Returns:</b></td>
<td class="field-body" width="100%"><b>clients : <i>dictionary<string,dspSettings></i></b> <td class="field-body" width="100%"><b>clients : <i>dictionary (string,dspSettings)</i></b>
<p class="attr"> <p class="attr">
A dictionary with the RTIS Client IDs as the keys and the DSP settings as the values. A dictionary with the RTIS Client IDs as the keys and the DSP settings as the values.
</p></td> </p></td>
...@@ -389,7 +395,7 @@ Useful for connected applications. ...@@ -389,7 +395,7 @@ Useful 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.py#L778">[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#L779">[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.
...@@ -426,10 +432,197 @@ Useful for connected applications. ...@@ -426,10 +432,197 @@ Useful for connected applications.
## **reload_config**
<p class="func-header">
<i>def</i> <b>reload_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#L828">[source]</a>
</p>
Tell the RTIS Server to reload its serverconfig.json file and read in the new settings.
Will also re-configure all connected RTIS Clients.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>serverIp : <i>string</i></b>
<p class="attr">
The IP on which the RTIS Server can be found.
</p>
<b>logger : <i>logging.logger (default = None)</i></b>
<p class="attr">
The logging library object to stream the messages to. If None then normal Print statement is used.
</p></td>
</tr>
</tbody>
</table>
## **prepare**
<p class="func-header">
<i>def</i> <b>prepare</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/RTISCommon.py#L855">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to start all workers.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>serverIp : <i>string</i></b>
<p class="attr">
The IP on which the RTIS Server can be found.
</p>
<b>logger : <i>logging.logger (default = None)</i></b>
<p class="attr">
The logging library object to stream the messages to. If None then normal Print statement is used.
</p></td>
</tr>
</tbody>
</table>
## **idle**
<p class="func-header">
<i>def</i> <b>idle</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/RTISCommon.py#L893">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to go idle
and stop all measurements and kill all running workers.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>serverIp : <i>string</i></b>
<p class="attr">
The IP on which the RTIS Server can be found.
</p>
<b>logger : <i>logging.logger (default = None)</i></b>
<p class="attr">
The logging library object to stream the messages to. If None then normal Print statement is used.
</p></td>
</tr>
</tbody>
</table>
## **stop**
<p class="func-header">
<i>def</i> <b>stop</b>(<i>serverIp, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/RTISCommon.py#L920">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to stop any running measurements.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>serverIp : <i>string</i></b>
<p class="attr">
The IP on which the RTIS Server can be found.
</p>
<b>logger : <i>logging.logger (default = None)</i></b>
<p class="attr">
The logging library object to stream the messages to. If None then normal Print statement is used.
</p></td>
</tr>
</tbody>
</table>
## **start**
<p class="func-header">
<i>def</i> <b>start</b>(<i>serverIp, measurements=0, frequency=0, active='0', logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/RTISCommon.py#L946">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to stop any running measurements.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>serverIp : <i>string</i></b>
<p class="attr">
The IP on which the RTIS Server can be found.
</p>
<b>measurements : <i>int</i></b>
<p class="attr">
Set a custom amount of measurements to record. If argument is not given it will be set to 0. Which results in continuous and infinite measurements.
</p>
<b>frequency : <i>int</i></b>
<p class="attr">
Set a custom measurement frequency. If not given will take the default set in the serversettings.json file.
</p>
<b>active : <i>string</i></b>
<p class="attr">
Set a custom list of active connections for the RTIS Sync device. If not given will take the default set in the serversettings.json file. Format: "X,X,X,X,X,X" where X is 1(active) or 0(inactive).
</p>
<b>logger : <i>logging.logger (default = None)</i></b>
<p class="attr">
The logging library object to stream the messages to. If None then normal Print statement is used.
</p></td>
</tr>
</tbody>
</table>
## **set_counter**
<p class="func-header">
<i>def</i> <b>set_counter</b>(<i>serverIp, index=0, logger=None</i>) <a class="src-href" target="_blank" href="https://cosysgit.uantwerpen.be/rtis-software/rtiscommon/-/blob/master/RTISCommon.py#L1054">[source]</a>
</p>
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to active.
Useful for connected applications.
<table class="docutils field-list field-table" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field">
<th class="field-name"><b>Parameters:</b></td>
<td class="field-body" width="100%"><b>serverIp : <i>string</i></b>
<p class="attr">
The IP on which the RTIS Server can be found.
</p>
<b>index : <i>int</i></b>
<p class="attr">
The new index to set the internal measurement counter on. Defaults to 0 if not given.
</p>
<b>logger : <i>logging.logger (default = None)</i></b>
<p class="attr">
The logging library object to stream the messages to. If None then normal Print statement is used.
</p></td>
</tr>
</tbody>
</table>
## **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.py#L827">[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#L1084">[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.
...@@ -458,7 +651,7 @@ Useful for connected applications. ...@@ -458,7 +651,7 @@ Useful 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.py#L854">[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#L1111">[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.
......