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 @ 356424e8
# RTIS Network General Usage
### A. Configuration
## Configuration
All configuration is done on the RTIS Server side. There are two configuration file types:
- [serversettings.json](Config/serversettings.json)
......@@ -34,7 +32,7 @@ Here is a more detailed explanation of each parameter:
},
"eRTIS001" : { [string, Use the RTIS Device´s unique identifier to define custom settings.]
... [the same values as above for the default configuration are required here too.]
"required" : 1 [integer, Set to 1 if this Client is required to be in the 'Ready' state for at least 1 minute before allowing further operation.]
"required" : 1 [integer, Set to 1 if this Client is required to be in the 'Ready' state for at least 30 seconds before allowing further operation.]
},
...
},
......@@ -42,9 +40,8 @@ Here is a more detailed explanation of each parameter:
"server": { [string, unique identifier to identify the processingSettings with which is used by serverProcessingName and clientSettings.]
"workers": 3, [integer, The amount of RTIS CUDA GPU workers that should be used for the DSP pipeline.]
"pdm" : 0, [integer, Disable or enable the binary data unpacking and PDM filtering part of the DSP pipeline. 0=off, 1=on]
"matchedFilter" : 0, [integer, Disable or enable the optional matched filter part of the DSP pipeline. 0=off, 1=on]
"matchedFilter" : 0, [integer, Disable or enable the matched filter part of the DSP pipeline. 0=off, 1=on]
"beamforming" : 1, [integer, Disable or enable beamforming part of the DSP pipeline. 0=off, 1=on]
"postFilter" : 0, [integer, Disable or enable the optional post processing filter of the DSP pipeline.. 0=off, 1=on]
"enveloppe" : 1, [integer, Disable or enable enveloppe creation part of the DSP pipeline. 0=off, 1=on]
"clean" : 1, [integer, Disable or enable cleaning of the Energyscape part of the DSP pipeline. 0=off, 1=on]
"DSPFolderName" : "2D_90_debug" [string, unique identifier to identify the DSPFiles foldername to use.]
......@@ -85,7 +82,7 @@ Here is a more detailed explanation of the `config.json` file:
```
As long as you create a new unique folder name and add this `config.json` file the server will generate all other necessary files.
### B. Control
## Control
Currently the RTIS Network can be controlled through a single CLI interface. This is defined by the [RTISControl.py](Python/RTISControl.py) script.
As described in the Installation steps, this could be binded to a CLI command such as `rtiscontrol`, which we will use throughout this description of the RTIS Control script.
......@@ -96,7 +93,7 @@ The CLI control uses different types of launch arguments. Note the difference in
**Configuration**: these can not be mixed together.
- `reload`: Reload the _serversettings.json_ and _DSPFiles_ and make Server and Client use (new) settings.
- `idle`: Disable GPU workers and measurement listener.
- `prepare`: Start GPU workers and measurement listener. This will check if all required Clients are stable and online.
- `prepare`: Start GPU workers and measurement listener. This will check if all required Clients are stable(online for 30 seconds) and online.
- `start`: Start Sonar measurements with SYNC. This willd o a check to make sure the Server and Client are ready first.
- `--measurements`: Choose amount of measurements (infinite by default).
- `--frequency`: Choose custom frequency that overrides the default in the _serversettings.json_ file.
......@@ -129,7 +126,7 @@ The state can be:
When in this status mode of the CLI interface, keyboard shortcuts are also available and listed on the screen to quickly perform certain commands.
### B. Web Interface
## Web Interface
Currently a simple web interface is available on the RTIS Network LAN. It can be reached from any webbrowser on `serverIp:5000`.
It offers the same functionality as RTIS Control CLI currently but is more user friendly.
......@@ -159,12 +156,15 @@ The state can be:
Furthermore, on the **Configuration page** one can safely configure the [serversettings.json](Config/serversettings.json) file from this web interface.
Lastly, on the **DSP Settings** page the [DSP Config folders](Config/DSPFiles) can be managed and generated easily as well.
### C. HTTP API
## HTTP API
Similarly as to the web API, all control functionality is also available as HTTP commands.
They will return status 200 on success and 400 (with error message as data) on failure.
The following functions can therefore be used:
- _Status_ - `http://serverIp:5000/api/status`: Get a JSON structure with the full status of the active network.
- _Server Configuration_ - `http://serverIp:5000/api/serverconfig`: Get a JSON structure with the full server configuration.
- _DSP Configurations_ - `http://serverIp:5000/api/dspconfigs`: Get a JSON structure with all the DSP configurations saved.
- _Idle mode_ - `http://serverIp:5000/api/idle`: Disable GPU workers and measurement listener.
- _Prepare workers_ - `http://serverIp:5000/api/prepare`: Start GPU workers and measurement listener.
- _Reload settings_ - `http://serverIp:5000/api/reload`: Reload the _serversettings.json_ and _DSPFiles_ and make Server and Client use (new) settings.
......@@ -179,7 +179,7 @@ The following functions can therefore be used:
- _-Customize active connectors_ - `http://serverIp:5000/api/start?active=string`: Choose which connections on RTIS Sync device should be activated that overrides the default in the serversettings.json file. Should be a string of the format `X,X,X,X,X,X` where each X is either 1(enabled) 0(disabled).
- Like normal HTTP, you can combine multiple arguments. For example: `http://serverIp:5000/api/start?frequency=10&measurements=250&active=1,1,1,0,0,0`
### D. Using and creating a RTIS Network application
## Using and creating a RTIS Network application
The idea of RTIS Network is to provide (processed) RTIS measurements of one or multiple RTIS sensors. In order to use these measurements one has to connect an application.
Several 'default' applications are already available:
......