Skip to content

Latest commit

 

History

History
114 lines (87 loc) · 8.11 KB

installation.md

File metadata and controls

114 lines (87 loc) · 8.11 KB
Raw

Linux Ubuntu Installation

Note: Due to the USB 3.0 translation layer between native hardware and virtual machine, the librealsense team does not support installation in a VM. If you do choose to try it, we recommend using VMware Workstation Player, and not Oracle VirtualBox for proper emulation of the USB3 controller.

Please ensure to work with the supported Kernel versions listed at distribution_linux and verify that the kernek is updated properly according to the instructions given there.

Ubuntu Build Dependencies

Make sure to have git and cmake installed as these are required for librelasense build:
sudo apt-get install git cmake3

Several scripts below invoke wget, git, add-apt-repository which may be blocked by router settings or a firewall. Infrequently, apt-get mirrors or repositories may also timeout. For librealsense users behind an enterprise firewall, configuring the system-wide Ubuntu proxy generally resolves most timeout issues.

Prerequisites

Important: Running RealSense Depth Cameras on Linux requires patching and inserting modified kernel drivers. Some OEM/Vendors choose to lock the kernel for modifications. Unlocking this capability may requires to modify BIOS settings

Make Ubuntu Up-to-date:

  1. Update Ubuntu distribution, including getting the latest stable kernel * sudo apt-get update && sudo apt-get upgrade && sudo apt-get dist-upgrade

    Note: On stock Ubuntu 14 LTS systems with Kernel prior to 4.4.0-04 the basic apt-get upgrade command is not sufficient to bring the distribution to the latest recommended baseline. On those systems use: sudo apt-get install --install-recommends linux-generic-lts-xenial xserver-xorg-core-lts-xenial xserver-xorg-lts-xenial xserver-xorg-video-all-lts-xenial xserver-xorg-input-all-lts-xenial libwayland-egl1-mesa-lts-xenial

  • Update OS Boot and reboot to enforce the correct kernel selection with sudo update-grub && sudo reboot

  • Interrupt the boot process at Grub2 Boot Menu -> "Advanced Options for Ubuntu" and select the kernel version installed in the previous step. Press and hold SHIFT if the Boot menu is not presented.

  • Complete the boot, login and verify that a supported kernel version (4.4.0-.., 4.8.0-.., 4.10.0-.. or 4.13.0-.. as of Feb 2018) is in place with uname -r

Video4Linux backend preparation:

  1. Ensure no Intel RealSense cameras are plugged in.

  2. Install openssl package required for kernel module build:
    * sudo apt-get install libssl-dev

  3. Install udev rules located in librealsense source directory:
    * sudo cp config/99-realsense-libusb.rules /etc/udev/rules.d/ * sudo udevadm control --reload-rules && udevadm trigger

  4. Build and apply patched kernel modules for
    * Ubuntu 14/16 LTS The script will download, patch and build several kernel modules (drivers).
    Then it will attempt to insert the patched module instead of the active one. If failed the original uvc module will be preserved.

    • ./scripts/patch-realsense-ubuntu-xenial.sh
      * Intel® Joule™ with Ubuntu Based on the custom kernel provided by Canonical Ltd.
      • ./scripts/patch-realsense-ubuntu-xenial-joule.sh
        * Arch-based distributions
    • You need to install the base-devel package group.
    • You also need to install the matching linux-headers as well (i.e.: linux-lts-headers for the linux-lts kernel).
      • Navigate to the scripts folder: cd ./scripts/
      • Then run the following script to patch the uvc module: ./patch-arch.sh
* Check installation by examining the patch-generated log as well as inspecting the latest entries in kernel log:
  `sudo dmesg | tail -n 50`<br />
The log should indicate that a new uvcvideo driver has been registered.  
   Refer to the "troubleshooting" chapter in case of errors/warning reports.
  1. Install the packages required for librealsense build:
    libusb-1.0, pkg-config and libgtk-3:
    sudo apt-get install libusb-1.0-0-dev pkg-config libgtk-3-dev.
    Note: glfw3 and gtk are only required if you plan to build the examples, not for the librealsense core library.
*glfw3*:
* On Ubuntu 16.04 install glfw3 via `sudo apt-get install libglfw3-dev`
* On Ubuntu 14.04 or when running of Ubuntu 16.04 live-disk, please use `./scripts/install_glfw3.sh`

  1. TM1-specifics: * Tracking Module requires hid_sensor_custom kernel module to operate properly. Due to TM1's power-up sequence constrains, this driver is required to be loaded during boot for the HW to be properly initialized.

    In order to accomplish this add the driver's name hid_sensor_custom to /etc/modules file, eg:

    echo 'hid_sensor_custom' | sudo tee -a /etc/modules`

Building librealsense2 SDK

  • On Ubuntu 14.04, update your build toolchain to gcc-5:

    • sudo add-apt-repository ppa:ubuntu-toolchain-r/test
    • sudo apt-get update
    • sudo apt-get install gcc-5 g++-5
    • sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 60 --slave /usr/bin/g++ g++ /usr/bin/g++-5
    • sudo update-alternatives --set gcc "/usr/bin/gcc-5"

    You can check the gcc version by typing: gcc -v If everything went fine you should see gcc 5.0.0.

  • Navigate to librealsense root directory and run mkdir build && cd build

  • Run CMake:

    • cmake ../ - The default build is set to produce the core shared object and unit-tests binaries in Debug mode. Use -D CMAKE_BUILD_TYPE=release to build with optimizations.
    • cmake ../ -DBUILD_EXAMPLES=true - Builds librealsense along with the demos and tutorials
    • cmake ../ -DBUILD_EXAMPLES=true -DBUILD_GRAPHICAL_EXAMPLES=false - For systems without OpenGL or X11 build only textual examples

Recompile and install librealsense binaries:

  • sudo make uninstall && make clean && make && sudo make install
    The shared object will be installed in /usr/local/lib, header files in /usr/local/include
    The demos, tutorials and tests will be located in /usr/local/bin
    Tip: Use make -jX for parallel compilation, where X stands for the number of CPU cores available:
    sudo make uninstall && make clean && make -j8 && sudo make install
    This enhancement may significantly improve the build time. The side-effect, however, is that it may cause a low-end platform to hang randomly
    Note: Linux build configuration is presently configured to use the V4L2 backend by default.
    Note: If you encounter the following error during compilation gcc: internal compiler error it might indicate that you do not have enough memory or swap space on your machine. Try closing memory consuming applications, and if you are running inside a VM increase available RAM to at least 2 GB.
  1. Install IDE (Optional): We use QtCreator as an IDE for Linux development on Ubuntu * Follow the link for QtCreator5 installation

Troubleshooting Installation and Patch-related Issues

Error Cause Correction Steps
git.launchpad... access timeout Behind Firewall Configure Proxy Server
dmesg:... uvcvideo: module verification failed: signature and/or required key missing - tainting kernel A standard warning issued since Kernel 4.4-30+ Notification only - does not affect module's functionality
sudo modprobe uvcvideo produces dmesg: uvc kernel module is not loaded The patched module kernel version is incompatible with the resident kernel Verify the actual kernel version with uname -r.
Revert and proceed from Make Ubuntu Up-to-date step
Execution of ./scripts/patch-video-formats-ubuntu-xenial.sh fails with fatal error: openssl/opensslv.h Missing Dependency Install openssl package from Video4Linux backend preparation step