Installation

ONLY TESTED ON MACOS

1. cd ~/pupil_capture_settings/plugins
2. git clone https://github.com/papr/pupil-picoflexx.git picoflexx
3. Download the PMD Royale SDK
4. Unzip the coorect zip file for your operating system, e.g. libroyale-3.20.0.62-APPLE-x86-64Bit.zip on macOS
5. Copy the contents from the Python sub folder into ~/pupil_capture_settings/plugins/picoflexx

To verify that everything works as expected, run the example files:

cd ~/pupil_capture_settings/plugins/picoflexx
python3 sample_camera_info.py

When starting Capture from bundle, you should see the following lines in your log file:

world - [INFO] plugin: Added: <class 'picoflexx.Picoflexx_Manager'>
world - [INFO] plugin: Added: <class 'picoflexx.Picoflexx_Source'>

If the requirements where not installed correctly, you should see the following line:

world - [WARNING] plugin: Failed to load 'picoflexx'. Reason: '<reason>'

Compile backend extension to greatly improve performance (optional)

1. Copy (or symlink) the Royale SDK include folder here, e.g. ln -s /path/to/libroyale-3.20.0.62-LINUX-x86-64Bit/include .
2. python setup.py build_ext

If the extension was not compiled/setup correctly, you should see the following line:

world - [WARNING] picoflexx.backend: Failed to load roypy_backend extension, falling back to roypy

If you're getting ImportError: cannot import name 'roypy_backend' even though the library was compiled, a common cause is the python version used to compile the extension differs from that used by Pupil Capture (Python 3.6).

Usage

Backend

1. Connect your Pico Flexx to the computer
2. Start Capture
3. Select the UVC Manager menu on the right
4. Select Pico Flexx from the selector
5. Click Activate Pico Flexx

You should see a color map of the camera's depth output.

Example Plugin

1. Run the backend usage steps above
2. Enable the Example Picoflexx Plugin in the Plugin Manager menu

See the example.plugin.py file on how to access the depth data from the backend.