Skip to content

Commit 5b0d5ad

Browse files
committed
Add libudev to installation readme
1 parent dd48c6d commit 5b0d5ad

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

doc/installation.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ The scripts and commands below invoke `wget, git, add-apt-repository` which may
3737
Unplug any connected Intel RealSense camera.<br />
3838

3939
2. Install the core packages required to build *librealsense* binaries and the affected kernel modules:
40-
`sudo apt-get install git libssl-dev libusb-1.0-0-dev pkg-config libgtk-3-dev` <br /><br />
40+
41+
`sudo apt-get install git libssl-dev libusb-1.0-0-dev libudev-dev pkg-config libgtk-3-dev` <br /><br />
4142
Distribution-specific packages: <br />
4243
* Ubuntu 14 or when running Ubuntu 16.04 live-disk:<br />
4344
`./scripts/install_glfw3.sh` <br />
@@ -51,8 +52,11 @@ The scripts and commands below invoke `wget, git, add-apt-repository` which may
5152
> **Cmake Note**: certain librealsense CMAKE flags (e.g. CUDA) require version 3.8+ which is currently not made available via apt manager for Ubuntu LTS.
5253
Go to the [official CMake site](https://cmake.org/download/) to download and install the application
5354

54-
**Note** on graphic sub-system utilization:<br />
55-
*glfw3*, *mesa* and *gtk* packages are required if you plan to build the SDK's OpenGL-enabled examples. The *librealsense* core library and a range of demos/tools are designed for headless environment deployment.
55+
**Note**:
56+
57+
* on graphic sub-system utilization:<br />
58+
*glfw3*, *mesa* and *gtk* packages are required if you plan to build the SDK's OpenGL-enabled examples. The *librealsense* core library and a range of demos/tools are designed for headless environment deployment.
59+
* `libudev-dev` installation is optional but recommended, when the `libudev-dev` is installed the SDK will use an event driven approach for triggering USB detection and enumeration, if not the SDK will use a timer polling approach which is less sensitive for device detection.
5660

5761
3. Run Intel Realsense permissions script from librealsense root directory:<br />
5862
`./scripts/setup_udev_rules.sh`
@@ -61,15 +65,14 @@ The scripts and commands below invoke `wget, git, add-apt-repository` which may
6165
*`./scripts/setup_udev_rules.sh --uninstall`*
6266

6367
4. Build and apply patched kernel modules for: <br />
64-
* **Ubuntu 14/16/18 with LTS kernel**
6568

69+
* **Ubuntu 14/16/18 with LTS kernel**
6670
`./scripts/patch-realsense-ubuntu-lts.sh`<br />
6771
* **Ubuntu with Kernel 4.16**
68-
6972
`./scripts/patch-ubuntu-kernel-4.16.sh`<br />
7073
* **Intel® Joule™ with Ubuntu**
7174
Based on the custom kernel provided by Canonical Ltd.
72-
75+
7376
`./scripts/patch-realsense-ubuntu-xenial-joule.sh`<br />
7477

7578
The script above will download, patch and build realsense-affected kernel modules (drivers).<br />
@@ -122,15 +125,15 @@ The scripts and commands below invoke `wget, git, add-apt-repository` which may
122125
* `cmake ../ -DBUILD_EXAMPLES=true -DBUILD_GRAPHICAL_EXAMPLES=false` - For systems without OpenGL or X11 build only textual examples<br /><br />
123126

124127
* Recompile and install *librealsense* binaries:<br />
125-
`sudo make uninstall && make clean && make && sudo make install`<br />
126-
The shared object will be installed in `/usr/local/lib`, header files in `/usr/local/include`.<br />
127-
The binary demos, tutorials and test files will be copied into `/usr/local/bin`<br />
128-
**Tip:** Use *`make -jX`* for parallel compilation, where *`X`* stands for the number of CPU cores available:<br />
129-
`sudo make uninstall && make clean && make **-j8** && sudo make install`<br />
130-
This enhancement may significantly improve the build time. The side-effect, however, is that it may cause a low-end platform to hang randomly.<br />
131-
**Note:** Linux build configuration is presently configured to use the V4L2 backend by default.<br />
132-
**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.<br />
133-
**Note:** You can find more information about the available configuration options on [this wiki page](https://github.com/IntelRealSense/librealsense/wiki/Build-Configuration).
128+
`sudo make uninstall && make clean && make && sudo make install`<br />
129+
The shared object will be installed in `/usr/local/lib`, header files in `/usr/local/include`.<br />
130+
The binary demos, tutorials and test files will be copied into `/usr/local/bin`<br />
131+
**Tip:** Use *`make -jX`* for parallel compilation, where *`X`* stands for the number of CPU cores available:<br />
132+
`sudo make uninstall && make clean && make **-j8** && sudo make install`<br />
133+
This enhancement may significantly improve the build time. The side-effect, however, is that it may cause a low-end platform to hang randomly.<br />
134+
**Note:** Linux build configuration is presently configured to use the V4L2 backend by default.<br />
135+
**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.<br />
136+
**Note:** You can find more information about the available configuration options on [this wiki page](https://github.com/IntelRealSense/librealsense/wiki/Build-Configuration).
134137

135138
2. Install IDE (Optional):
136139
We use QtCreator as an IDE for Linux development on Ubuntu. Follow the [link](https://wiki.qt.io/Install_Qt_5_on_Ubuntu) for QtCreator5 installation

0 commit comments

Comments
 (0)