Intel® RealSense™ SDK 2.0 Github User Guide May 2018 Revision 002 Document Number: 337595-002 You may not use or facilitate the use of this document in connection with any infringement or other legal analysis concerning Intel products described herein. You agree to grant Intel a non-exclusive, royalty-free license to any patent claim thereafter drafted which includes subject matter disclosed herein. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document. Intel technologies’ features and benefits depend on system configuration and may require enabled hardware, software or service activation. Performance varies depending on system configuration. No computer system can be absolutely secure. Check with the system manufacturer or retailer or learn more at intel.com. Intel technologies may require enabled hardware, specific software, or services activation. Check with the system manufacturer or retailer. The products described may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request. Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade. All information provided here is subject to change without notice. Contact the Intel representative to obtain the latest Intel product specifications and roadmaps. Copies of documents which have an order number and are referenced in this document may be obtained by calling 1-800-548- 4725 or visit www.intel.com/design/literature.htm. Intel, RealSense and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries. *Other names and brands may be claimed as the property of others. Copyright © 2018, Intel Corporation. All Rights Reserved. § § 2 337595-002 Contents 1 Introduction .................................................................................................... 5 1.1 Purpose and Scope of this Document ........................................................ 5 2 LibRealSense SDK 2.0 Overview ......................................................................... 6 2.1 Intended Users ..................................................................................... 6 2.2 Features .............................................................................................. 6 2.3 Description ........................................................................................... 6 3 GitHub ........................................................................................................... 7 3.1 Navigating GitHub Content ..................................................................... 7 3.1.1 Code ...................................................................................... 7 3.1.1.1 Section A .................................................................. 7 3.1.1.2 Section B .................................................................. 8 3.1.1.3 Section C .................................................................. 8 3.1.2 Issues .................................................................................... 8 3.1.2.1 Section A .................................................................. 9 3.1.2.2 Section B .................................................................. 9 3.1.3 Pull Request ............................................................................ 9 3.1.3.1 Section A ................................................................ 10 3.1.3.2 Section B ................................................................ 10 3.1.4 Project .................................................................................. 10 3.1.5 Wiki ..................................................................................... 11 3.1.6 Insights ................................................................................ 11 4 Install/Build LibRS .......................................................................................... 12 4.1 Install Pre-Built LibRS .......................................................................... 12 4.1.1 Windows* .............................................................................. 12 4.1.1.1 Intel® RealSenseTM Viewer ........................................ 12 4.1.1.2 Installing the SDK .................................................... 13 4.1.2 Linux* ................................................................................... 15 4.1.2.1 Supported Distribution.............................................. 15 4.1.2.2 Install Steps ........................................................... 15 4.1.2.3 Uninstall Steps ........................................................ 16 4.1.2.4 Package Details ....................................................... 16 4.2 Compile LibRS Source Code .................................................................. 17 4.2.1 Windows* 8.1 and Windows* 10 Installation ............................... 17 4.2.1.1 Windows* 8.1 .......................................................... 17 4.2.1.2 Enabling Metadata on Windows* ................................. 18 4.2.1.3 Compiling Librealsense with Metadata Support ............. 21 4.2.2 Linux* ................................................................................... 22 4.2.2.1 Ubuntu* Build Dependencies ...................................... 22 4.2.2.2 Prerequisites ........................................................... 22 4.2.2.3 Building Librealsense2 SDK ....................................... 24 4.2.3 Mac OS Installation ................................................................ 25 4.2.4 Android* Installation............................................................... 25 4.2.4.1 Build Intel® RealSense™ SDK 2.0 for Android* OS ....... 25 5 Additional reference ....................................................................................... 28 § § 337595-002 3 Revision History Document Revision Description Revision Date Number Number 337595 001 • Initial release May 2018 002 • Added Mac OS/Android installation guide May 2018 § § 4 337595-002 Introduction 1 Introduction 1.1 Purpose and Scope of this Document This document guides user how to navigate through the Github web page and install the librealsense pre-built package or compile from source code. § § 337595-002 5 LibRealSense SDK 2.0 Overview 2 LibRealSense SDK 2.0 Overview 2.1 Intended Users LibRealSense SDK 2.0 is designed for developers. 2.2 Features • Cross platform API for Intel® RealSense™ D400 series and SR300 cameras • Tool supports Windows* 10, MAC OS and Linux* 2.3 Description LibRealSense SDK 2.0 is a cross platform library designed for end users/developers to implement custom applications using the RealSense™ SR300 and D400 series cameras. The SDK allows depth and color streaming, and provides intrinsic and extrinsic calibration information. The library also offers synthetic streams (pointcloud, depth aligned to color and vise-versa), and a built-in support for record and playback of streaming sessions. § § 6 337595-002 GitHub 3 GitHub 3.1 Navigating GitHub Content The section guides developers how to navigate through the repository: 3.1.1 Code The tab contains various code related information/feature, such as clone or download the code, change to different branch, get the public release etc. Below will break down the page into three sections for more detailed information: 3.1.1.1 Section A • Commits − List detailed information about each commit to the branch • Branches − Shows the number of available branches in the repository • Releases − List the available public releases • Contributors − Provide statistics of contribution from developers 337595-002 7 GitHub 3.1.1.2 Section B • Branches − Drop box, select to bring up the up to date files within specific branch • New pull request − Button, creates a new commit request to repository owner to review then merge into repository. The feature requires developers to fork the repository to their own repository, complete the changes within local repository then submit the pull request. For more detailed information refer to https://github.com/IntelRealSense/librealsense/blob/master/CONTRIBUTING.md • Create/Upload files − The feature is not available, for developers that want to create or upload new file, follow the pull request guidance • Clone or download − Drop box, copy the URL to clone from local git tool, or download the packed source code as zip file directly 3.1.1.3 Section C Viewing the architecture of each folder or code: • Folder − Click to view the file architecture of the folder • Source code − Click to invoke github native viewer to view the code 3.1.2 Issues The tab contains issues from developers, the page provides easy to search and filter tools. Developer can search if any existing similar issue before create new one, which saves time to wait for response: 8 337595-002 GitHub 3.1.2.1 Section A • Filters − Change the search scope, such as searching with the own issues, any issue assigned to/mentioning you etc. • Search field − Type any keyword for searching • Labels − List down available labels, click the label will redirect to page with all issues with the label • Milestones − List down available milestones, click the milestone will redirect to page with all issues related to the milestone