Getting started
Installing XiLens via apt
You can install XiLens by downloading the corresponding .deb package from our release page.
And then install it by doing:
This will install XiLens and its dependencies that are available in apt.
Dependencies
XiLens still depends on BLOSC2 and XiAPI. These packages are not available via apt, which is why they
are not installed by apt when installing the .deb package.
These additional dependencies can be installed by running:
XiLens you would only need to
install the .deb package.
Updating XiLens
To update XiLens, you only need to either re-build it, or simply download the latest .deb package from our release page
and re-install it.
Build XiLens from source
Install dependencies
To build XiLens you only need to install the dependencies and run the
build as in the following commands.
Installation directory
You should run this from a directory where BLOSC2 and XiAPI will be downloaded.
This takes care of installing dependencies including the xiAPI package provided by XIMEA and BLOSC2.
User vs. Development dependencies
The previous script will install BLOSC2 and XiAPI on your system!
If you are building the application for development purposes, you should remove the flag --user to install the
development dependencies instead.
Build application
From the root directory of XiLens do the following.
mkdir build && cd build
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make all -j
ctest # to check that all tests pass
sudo make install # installs the desktop app on the system and can be accessed from the app launcher
Static build
XiLens can be built statically by adding a flag during configuration cmake -DBUILD_STATIC -DCMAKE_INSTALL_PREFIX=/usr ..
The application can be uninstalled from the system by doing sudo make uninstall form the build directory
Enable connection to cameras
Increase USB buffer limit
USB buffer size
After building XiLens, you have to increase the buffer size for the
data transfer via USB. This can be done every time you start your
computer by running the following command.
To prevent having to run this command every time you restart your PC, you can create a daemon service that would start automatically every time you start your computer.
You will need to paste the following content in the file opened above
[Unit]
Description=Increase USB Buffer Size
[Service]
ExecStart=/bin/bash -c 'sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb >/dev/null <<<0'
Type=oneshot
RemainAfterExit=yes
[Install]
WantedBy=multi-user.target
Then you have to enable and start the service
sudo systemctl enable usb-buffer-size.service
sudo systemctl start usb-buffer-size.service
service usb-buffer-size status
You should see that the service is marked as active.
Add user to pugdev group
After doing the following, you will have to log-out and log-in again for this tot ake effect.
Launching the application
After doing sudo make install from the build directory, the desktop app should be available through the app launcher
of your system.
Alternatively, you can run ./xilens from the build directory in a terminal.
Uninstalling XiLens
If you installed XiLens with the .deb package, then you can uninstall it by doing sudo apt uninstall xilens.
If you build the app from source, you can uninstall it by doing the following from the directory where XiLens was built.
Docker image
Qt inside a docker image
Running a Qt application inside docker is not straight forward. Building the docker image can serve to test your developed code to make sure that it will work in other systems, however running the application inside docker is still under development.