|
|
|
# RTIS Dev Matlab Wrapper
|
|
|
|
|
|
|
|
This is a wrapper of the RTIS Dev Remote library to use RTIS Dev remotely over IP from MATLAB.
|
|
|
|
Quickly develop with connected RTIS devices. Almost all RTIS Dev functions are available as well as automatic conversion
|
|
|
|
of RTIS Dev custom class objects.
|
|
|
|
|
|
|
|
# Unavailable RTIS Dev methods
|
|
|
|
Here is a short list of the current RTIS Dev methods that aren't available through this wrapper:
|
|
|
|
* [create_measure_external_trigger_queue](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#create_measure_external_trigger_queue)
|
|
|
|
* [create_measure_external_trigger_callback](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#create_measure_external_trigger_queue)
|
|
|
|
* [set_log_mode](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#create_measure_external_trigger_queue)
|
|
|
|
* [set_custom_logger](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#create_measure_external_trigger_queue)
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
### Initial setup
|
|
|
|
When starting with this wrapper, first try to make a connection the remote RTIS Device.
|
|
|
|
This both tests the connection as makes sure that the RTIS Dev version used on the remote device is supported by the version of this wrapper.
|
|
|
|
The only required argument is the IP of the remote RTIS Device. To learn more about how to find out the IP, please see this [guide](https://cosysgit.uantwerpen.be/rtis-software/ertissoftwareusageguide/-/wikis/Initial-Connection-&-Network-Setup).
|
|
|
|
```matlab
|
|
|
|
rtisdev = RTISDev("192.168.1.150");
|
|
|
|
```
|
|
|
|
Now the `rtisdev` object can be used to run RTIS Dev methods from.
|
|
|
|
|
|
|
|
### Executing remote methods
|
|
|
|
After the connection is made and no errors were shown, you can now use [all available RTIS Dev commands](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home). Some don't work and are listed in the [list](#unavailable-rtis-dev-methods) above.
|
|
|
|
Please use the [RTIS Dev wiki](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home) to know which arguments to use.
|
|
|
|
There is a difference between using optional and required arguments. For example, a RTIS Dev method with a required argument needs to given explicitly:
|
|
|
|
```matlab
|
|
|
|
rtisdev.open_connection();
|
|
|
|
```
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
There is a difference between using optional and required arguments. For example, a RTIS Dev method with a required argument needs to given explicitly:
|
|
|
|
```matlab
|
|
|
|
rtisdev.set_settings_from_class(settings);
|
|
|
|
```
|
|
|
|
Whereas optional arguments should be given as name/value pairs:
|
|
|
|
```matlab
|
|
|
|
rtisdev.set_recording_settings('callDuration', 4.4, 'callMinimumFrequency', int32(30000), 'callMaximumFrequency', int32(60000));
|
|
|
|
```
|
|
|
|
Please see the [RTIS Dev wiki](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home) to know which arguments are optional and which are required.
|
|
|
|
|
|
|
|
### Data types
|
|
|
|
As seen in the example below, place special attention to some data types as otherwise the argument parser will give an error.
|
|
|
|
Integers should be actual integers and created with `int32()`. Similarly, strings need double quotations to be a true string.
|
|
|
|
```matlab
|
|
|
|
rtisdev.set_recording_settings('callMinimumFrequency', int32(30000), 'configName', "test");
|
|
|
|
```
|
|
|
|
Some methods return or require one of the [RTIS Dev custom class object](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#classes).
|
|
|
|
The RTIS Dev MATLAB wrapper will automatically convert these to MATLAB struct objects.
|
|
|
|
When these structs are provided as arguments, the wrapper will automatically convert them again so it should all work straight out of the box!
|
|
|
|
```matlab
|
|
|
|
settings = rtisdev.get_current_settings();
|
|
|
|
rtisdev.set_settings_from_class(settings);
|
|
|
|
|
|
|
|
measurement_raw = rtisdev.get_raw_measurement('behaviour', true);
|
|
|
|
measurement_processed_from_raw = rtisdev.process_measurement(measurement_raw);
|
|
|
|
```
|
|
|
|
|
|
|
|
## Example
|
|
|
|
A bigger example showing how to connect, record and process a measurement and plot the microphone signals and RTIS Energyscape.
|
|
|
|
```matlab
|
|
|
|
rtisdev = RTISDev("192.168.1.150");
|
|
|
|
|
|
|
|
rtisdev.open_connection();
|
|
|
|
|
|
|
|
rtisdev.set_recording_settings('premade', "default_25_50");
|
|
|
|
rtisdev.set_processing_settings('premade', "2D_5m_181");
|
|
|
|
|
|
|
|
settings = rtisdev.get_current_settings();
|
|
|
|
|
|
|
|
measurement_processed = rtisdev.get_processed_measurement('behaviour', true);
|
|
|
|
|
|
|
|
%% Plot of raw microphone data
|
|
|
|
|
|
|
|
data = de2bi(measurement_processed.rawData, 32);
|
|
|
|
|
|
|
|
% Generate settings for converting to microphone signals. These have to match the recording settings!
|
|
|
|
fs_pdm = double(settings.pdmSampleFrequency); % PDM samplefrequency
|
|
|
|
fs_mic = double(settings.dacSampleFrequency); % Microphone samplefrequency
|
|
|
|
|
|
|
|
% PDM demodulation.
|
|
|
|
[b_pdm, a_pdm] = butter(6, 100e3 / ( fs_pdm / 2));
|
|
|
|
[b_bpf, a_bpf] = butter(6, [20e3 80e3] / (fs_mic / 2));
|
|
|
|
data_filtered = (filter(b_pdm, a_pdm, data));
|
|
|
|
data_filtered_dec = data_filtered(1:10:end, :);
|
|
|
|
data_mics = filter(b_bpf, a_bpf, data_filtered_dec);
|
|
|
|
|
|
|
|
% Plot the recording microphone signals
|
|
|
|
figure()
|
|
|
|
for plotcounter = 1 : 16
|
|
|
|
subplot(4, 4, plotcounter);
|
|
|
|
sig_out1 = data_mics(:, plotcounter) - mean(data_mics(:,plotcounter));
|
|
|
|
plot(sig_out1 + 1);
|
|
|
|
hold on;
|
|
|
|
sig_out2 = data_mics(:, plotcounter + 16) - mean(data_mics(:, plotcounter + 16));
|
|
|
|
plot(sig_out2 - 1);
|
|
|
|
ylim([-1.5 1.5])
|
|
|
|
hold off;
|
|
|
|
plottitle = sprintf('Microphone %d and %d', plotcounter, plotcounter + 16);
|
|
|
|
title(plottitle);
|
|
|
|
end
|
|
|
|
|
|
|
|
%% Plot of processed data
|
|
|
|
|
|
|
|
figure()
|
|
|
|
imagesc(measurement_processed.processedData');
|
|
|
|
colormap hot
|
|
|
|
xlabel("Directions (degrees)")
|
|
|
|
ylabel("Range (meters)")
|
|
|
|
ax = gca;
|
|
|
|
set(gca,'Ydir','normal')
|
|
|
|
xt = get(gca, 'XTick');
|
|
|
|
yt = get(gca, 'YTick');
|
|
|
|
xt = 1 : 15 : length(settings.directions);
|
|
|
|
yt = 1 : 100 : length(settings.ranges);
|
|
|
|
xtlbl = rad2deg(settings.directions(xt));
|
|
|
|
ytlbl = settings.ranges(yt);
|
|
|
|
ytickformat('%.1f')
|
|
|
|
set(gca, 'XTick',xt, 'XTickLabel',xtlbl)
|
|
|
|
set(gca, 'YTick',yt, 'YTickLabel',ytlbl)
|
|
|
|
title('Energyscape');
|
|
|
|
``` |
|
|
|
\ No newline at end of file |
