... | ... | @@ -7,10 +7,10 @@ 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)
|
|
|
* [create_measure_external_trigger_callback](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#create_measure_external_trigger_callback)
|
|
|
* [create_processing_workers](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#create_processing_workers)
|
|
|
* [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)
|
|
|
* [set_log_mode](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#set_log_mode)
|
|
|
* [set_custom_logger](https://cosysgit.uantwerpen.be/rtis-software/rtisdev/-/wikis/home#set_custom_logger)
|
|
|
|
|
|
## Usage
|
|
|
|
... | ... | @@ -28,11 +28,12 @@ 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:
|
|
|
The commands should be called from the `rtisdev` objects. For example:
|
|
|
```python
|
|
|
rtisdev.open_connection()
|
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
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.
|
|
|
They use the exact same naming formats.
|
|
|
```python
|
... | ... | @@ -41,7 +42,7 @@ rtisdev.set_recording_settings(callDuration=4.4, callMinimumFrequency=30000, cal |
|
|
|
|
|
When you provide wrong arguments or run into other exceptions of RTIS Dev, the Python wrapper will raise a exception listing and describing the problem.
|
|
|
|
|
|
### RTIS Dev Custom Data types
|
|
|
### Custom data types
|
|
|
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 Python wrapper will automatically convert these to Python dictionary objects.
|
|
|
When these dictionary objects are provided as arguments, the wrapper will automatically convert them again so it should all work straight out of the box!
|
... | ... | @@ -61,7 +62,7 @@ import numpy as np |
|
|
import rtisdevremotepy
|
|
|
|
|
|
# Connect and verify matching versions of RTIS Dev
|
|
|
rtisdev = rtisdevremotepy.RTISDev("localhost")
|
|
|
rtisdev = rtisdevremotepy.RTISDev("192.168.1.150")
|
|
|
|
|
|
# Connect to RTIS Device
|
|
|
rtisdev.open_connection()
|
... | ... | @@ -71,11 +72,6 @@ rtisdev.set_recording_settings(premade="default_25_50") |
|
|
rtisdev.set_processing_settings(premade="2D_5m_181")
|
|
|
settings = rtisdev.get_current_settings()
|
|
|
|
|
|
premade_processing = rtisdev.get_premade_processing_settings_list()
|
|
|
premade_recording = rtisdev.get_premade_recording_settings_list()
|
|
|
rtisdev.unload_processing()
|
|
|
rtisdev.prepare_processing()
|
|
|
|
|
|
# Get an ACTIVE measurement (protect your ears!) and process it
|
|
|
measurement_processed = rtisdev.get_processed_measurement(behaviour=True)
|
|
|
|
... | ... | |