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 @ a6fef941
......@@ -47,8 +47,8 @@ while True:
if not packet:
break
data.append(packet)
dataPackage = pickle.loads(b"".join(data))
print("measurement #" + dataPackage[4] + " received!")
dataPackage = pickle.loads(b"".join(data))
print("measurement #" + str(dataPackage[4]) + " from RTIS Client '" + dataPackage[0] + "' received!")
except socket.error as ex:
print("the RTIS Server aborted the data connection: " + str(ex))
except pickle.UnpicklingError as ex:
......@@ -229,7 +229,7 @@ Method to check if a RTIS Client has timed out based on a check if it is previou
<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#L242">[source]</a>
</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 30 seconds
to indicate it is fully ready and stable for operation.
<table class="docutils field-list field-table" frame="void" rules="none">
......@@ -372,7 +372,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/rtiscommon/-/blob/master/RTISCommon.py#L600">[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#L602">[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.
......@@ -408,7 +408,7 @@ Useful 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/rtiscommon/-/blob/master/RTISCommon.py#L677">[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#L679">[source]</a>
</p>
A method to connect to the RTIS Server and get all the active connected RTIS Clients
......@@ -445,7 +445,7 @@ Useful 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/rtiscommon/-/blob/master/RTISCommon.py#L774">[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#L776">[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.
......@@ -485,7 +485,7 @@ 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#L823">[source]</a>
<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#L825">[source]</a>
</p>
Tell the RTIS Server to reload its serverconfig.json file and read in the new settings.
......@@ -514,7 +514,7 @@ Will also re-configure all connected RTIS Clients.
## **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#L850">[source]</a>
<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#L852">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to start all workers.
......@@ -542,7 +542,7 @@ Tell the RTIS Server and connected RTIS Clients to start all workers.
## **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#L888">[source]</a>
<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#L890">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to go idle
......@@ -571,7 +571,7 @@ and stop all measurements and kill all running workers.
## **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#L915">[source]</a>
<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#L917">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to stop any running measurements.
......@@ -599,7 +599,7 @@ Tell the RTIS Server and connected RTIS Clients to stop any running measurements
## **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#L941">[source]</a>
<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#L943">[source]</a>
</p>
Tell the RTIS Server and connected RTIS Clients to stop any running measurements.
......@@ -639,7 +639,7 @@ Tell the RTIS Server and connected RTIS Clients to stop any running measurements
## **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#L1049">[source]</a>
<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#L1051">[source]</a>
</p>
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to active.
......@@ -672,7 +672,7 @@ Useful 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/rtiscommon/-/blob/master/RTISCommon.py#L1079">[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#L1081">[source]</a>
</p>
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to active.
......@@ -701,7 +701,7 @@ Useful 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/rtiscommon/-/blob/master/RTISCommon.py#L1106">[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#L1108">[source]</a>
</p>
A method to connect to the RTIS Server tell all connected RTIS Clients to set their sonar behaviour to passive.
......