PrimeSense Sensor Module for OpenNI (Version 5.1.2.1 - May 15th 2012) --------------------------------------------------------------------- Website: http://www.primesense.com Forum: http://groups.google.com/group/openni-dev Wiki: http://wiki.openni.org Binaries are available at: http://www.openni.org/Downloads/OpenNIModules.aspx (The "OpenNI Compliant Hardware Binaries" section) Sources are available at: https://github.com/PrimeSense/Sensor or https://github.com/PrimeSense/Sensor/tree/unstable for the unstable branch Release Notes: -------------- * At the moment, the default is to compile the code with SSE3 support (this is also true for the supplied binaries). If you have a CPU without such support, please remove the sse compiler flags from the make files. (A good hint for this error is that you encounter an "illegal instructions" messages) * By default, the linux kernel mounts unknown USB devices with write permissions to root only, and read-only permissions to other users. When not running as root, this prevents communicating with the device. To fix this issue: - Navigate to Platform/Linux/Build - run 'make install-usb-rules' - if the device was connected, unplug and reconnect it. This part is done automatically by the install script, but you will need to do it manually if you choose not to use the automated install. * Linux: The device driver contains a thread for reading from the USB device. This thread should have high priority in order to function correctly. Each process using the device driver should have the CAP_SYS_NICE capability in order to raise thread priority. Failing to have that capability, will cause a failure in setting priority, consequently causing loss of data. * MacOSX: Only OSX 10.6 (Snow Leopard) and above with a 64-bit Intel based CPU is currently supported. Client/Server is not supported yet so do not attempt to access the sensor with more then one application. Build Notes: ------------ Windows: Requirements: 1) Microsoft Visual Studio 2010 From: http://msdn.microsoft.com/en-us/vstudio/bb984878.aspx 2) Python 2.6+/3.x From: http://www.python.org/download/ 3) PyWin32 From: http://sourceforge.net/projects/pywin32/files/pywin32/ Please make sure you download the version that matches your exact python version. 4) WIX 3.5 From: http://wix.codeplex.com/releases/view/60102 5) OpenNI 1.5.x.x From: http://www.openni.org/Downloads/OpenNIModules.aspx Optional Requirements (To build the documentation): 1) Doxygen From: http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc 2) GraphViz From: http://www.graphviz.org/Download_windows.php Building Sensor: 1) Go to the directory: "Platform\Win32\CreateRedist". Run the script: "Redist.py". This will compile and prepare the redist exe files that includes everything. 2) Install the exe you've just made which is located in Platform\Win32\CreateRedist\FinalXX\Sensor-Win32-5.x.x.x.exe (XX being the number of bits: 32 or 64) The installer will also automatically register all the modules into OpenNI via the NiReg utility. The visual studio solution is located in: Platform\Win32\Build\EngineWin32.sln. Important: Please note that even though the directory is called Win32, you can also use it to compile it for 64-bit targets (AMD64/x64). Linux: Requirements: 1) GCC 4.x From: http://gcc.gnu.org/releases.html Or via apt: sudo apt-get install g++ 2) Python 2.6+/3.x From: http://www.python.org/download/ Or via apt: sudo apt-get install python 3) OpenNI 1.5.x.x From: http://www.openni.org/Downloads/OpenNIModules.aspx Building Sensor: 1) Go into the directory: "Platform/Linux/CreateRedist". Run the script: "./RedistMaker". This will compile everything and create a redist package in the "Platform/Linux/Redist" directory. It will also create a distribution in the "Platform/Linux/CreateRedist/Final" directory. 2) Go into the directory: "Platform/Linux/Redist". Run the script: "sudo ./install.sh" (needs to run as root) The install script copies key files to the following location: Libs into: /usr/lib Bins into: /usr/bin Config files into: /usr/etc/primesense USB rules into: /etc/udev/rules.d Logs will be created in: /var/log/primesense To build the package manually, you can run "make" in the "Platform\Linux\Build" directory. Important: Please note that even though the directory is called Linux, you can also use it to compile it for 64-bit targets and pretty much any other linux based environment. Building Sensor using a cross-compiler: 1) Make sure to define two environment variables: - <platform>_CXX - the name of the cross g++ for platform <platform> - <platform>_STAGING - a path to the staging dir (a directory which simulates the target root filesystem). Note that <platform> should be upper cased. For example, if wanting to compile for ARM from a x86 machine, ARM_CXX and ARM_STAGING should be defined. 2) Go into the directory: "Platform/Linux/CreateRedist". Run: "./RedistMaker <platform>" (for example: "./RedistMake Arm"). This will compile everything and create a redist package in the "Platform/Linux/Redist" directory. It will also create a distribution in the "Platform/Linux/CreateRedist/Final" directory. 3) To install OpenNI files on the target file system: Go into the directory: "Platform/Linux/Redist". Run the script: "./install.sh -c $<platform>_STAGING" (for example: "./install.sh -c $ARM_STAGING"). The install script copies key files to the following location: Libs into: STAGING/usr/lib Bins into: STAGING/usr/bin Config files into: STAGING/usr/etc/primesense USB rules into: STAGING/etc/udev/rules.d Logs will be created in: STAGING/var/log/primesense To build the package manually, you can run "make PLATFORM=<platform>" in the "Platform\Linux\Build" directory. If you wish to build the Mono wrappers, also run "make PLATFORM=<platform> mono_wrapper" and "make PLATFORM=<platform> mono_samples". MacOSX: Requirements: 1) For Mac OSX 10.7, Xcode 4.3.2 From: http://developer.apple.com/devcenter/mac/index.action http://adcdownload.apple.com/Developer_Tools/xcode_4.3.2/xcode_432_lion.dmg You will also need to download and install the "Commandline Tools for XCode - Late March 2012" package: http://adcdownload.apple.com/Developer_Tools/command_line_tools_for_xcode_4.4__late_march_2012/cltools_lion_latemarch12.dmg Note: Since Xcode is now a normal application, it no longer automatically install itself. You have to copy&paste Xcode yourself into your Applications folder. (or run the application "Install Xcode" from your Applications folder / LaunchPad). It's also recommended to run the following command after you do the above: sudo xcode-select -switch /Applications/Xcode.app/ For Mac OSX 10.6, Xcode 3.2.6: From: http://developer.apple.com/devcenter/mac/index.action http://developer.apple.com/devcenter/download.action?path=/Developer_Tools/xcode_3.2.6_and_ios_sdk_4.3__final/xcode_3.2.6_and_ios_sdk_4.3.dmg Please note that you need to register as a mac developer (It's free!). 2) OpenNI 1.5.x.x From: http://www.openni.org/Downloads/OpenNIModules.aspx Building Sensor: 1) Go into the directory: "Platform/Linux/CreateRedist". Run the script: "./RedistMaker". This will compile everything and create a redist package in the "Platform/Linux/Redist" directory. It will also create a distribution in the "Platform/Linux/CreateRedist/Final" directory. 2) Go into the directory: "Platform/Linux/Redist". Run the script: "sudo ./install.sh" (needs to run as root) The install script copies key files to the following location: Libs into: /usr/lib Bins into: /usr/bin Config files into: /usr/etc/primesense USB rules into: /etc/udev/rules.d Logs will be created in: /var/log/primesense To build the package manually, you can run "make" in the "Platform\Linux\Build" directory.