ksandom / installUltraleap

Instructions and scripts to help install Ultramotion hand tracking (F.K.A. LeapMotion)

Install Ultraleap

These are instructions for getting the LeapMotion SDK 2.3.1 working on Linux, Windows, and MacOS. This is for use with applications that require it to interact with the LeapMotion controller.

Ultraleap (F.K.A LeapMotion) still works really well in Linux and Windows, despite not having received an update for several years. The documentation and installation process, however, have aged a bit. This repo is here to solve that in a coherent way and will be provided to upstream.

These instructions match SDK version 2.3.1, which is currently the newest version on Linux and Mac as at 2021-11-04 (Windows is currently on 5.3.1). It is also the latest version that is known to support Java, and is still downloadable.

Table of contents

• Install Ultraleap
  • Table of contents
  • Problems that this repo fixes
  • Links
  • Download and unpack the SDK
  • Install
    • Linux
      • Unpack the archive
      • Install on deb based distros
      • Install on RPM based distros
      • Make the service start
      • Testing it
      • Libraries for java applications
    • Windows
      • Install it
      • Libraries for java applications
    • MacOS
      • Libraries for java applications

Problems that this repo fixes

• Reliably starting and stopping the service via systemd.
• Installation on other Linux distros.

Ultraleap are welcome to incorporate and/all of this into their instructions that they ship with the SDK.

Links

1. More documentation.

Download and unpack the SDK

NOTE that downloading the SDK requires an account, which at the time of this writing, is free.

1. Go to Legacy releases. There are several packages on the same page.
2. You need "TRACKING SOFTWARE ____ 2.3.1" (Replace ____ with Linux/Windows/MacOS).
   • Linux
   • Windows
   • MacOS
3. Follow on either Linux, Windows, or MacOS.

Install

Linux

Unpack the archive

1. Run tar xzf Leap_Motion_SDK_Linux_2.3.1.tgz
2. Run cd LeapDeveloperKit_2.3.1+31549_linux

Install on deb based distros

The packaged instructions should work as described.

sudo dpkg --install Leap-*-x64.deb

TODO I haven't tested this in several years. Test this.

Install on RPM based distros

Derived from the packaged instructions.

Tested on

• OpenSuSE Tumbleweed on 2021-11-04.

TODO Test others.

1. Install alien if you haven't already. - This converts the debs to RPMs that you can install.
   • OpenSuSE: Choose a package.
   • Fedora: sudo yum install alien
2. Convert the debs by running sudo alien -rv --scripts Leap-*-x64.deb
3. Install the RPMs by running sudo rpm -ivh --nodeps --force leap-*x86_64.rpm

Make the service start

1. Run one of these two to get the systemd unit file and script to install it.
   • git clone [e-mail]:ksandom/installUltraleap.git
   • git clone https://github.com/ksandom/installUltraleap.git
2. Run cd installUltraleap to get into the repo directory.
3. Run sudo ./scripts/setupSystemd to set it up so that it will start at boot.
4. Run sudo systemctl start leapd to start it now.
5. Run sudo systemctl start leapd-resume to make it automatically restart when your computer resumes from suspend. This is to work-around the device not always coming back into a useable state after suspend.
6. [optional] Run sudo journalctl -fu leapd to see logs.

Testing it

If running LeapControlPanel is broken for you (This is explained well in the package README.); You can run LeapControlPanel --showsettings

From there, there are various things of interest. I want to highlight:

• "Diagnostic Visualizer" on the "Troubleshooting" tab, which shows you a realtime 3D visualisation of what the device is reporting. (Also great fun to play with.)
• "Show Software Log" on the "Troubleshooting" tab, which tells you why something is or is not working.

You can also run sudo journalctl -fu leapd to see the log.

Libraries for java applications

The files that you will need for java applications are located in:

• LeapSDK/lib:
  • LeapJava.jar
• LeapSDK/lib/x64:
  • libLeapJava.so
  • libLeap.so

Copy these to the lib directory that the java application specifies.

Windows

Install it

1. Unpack the .zip file.
2. Run Leap_Motion_Installer_release_public_win_x86_2.3.1+31549_ah1886.exe.

Libraries for java applications

The files that you will need for java applications are located in:

• LeapSDK\lib:
  • LeapJava.jar
• LeapSDK\lib\x64:
  • Leap.dll
  • LeapJava.dll
  • Leap.lib

Copy these to the lib directory that the java application specifies.

MacOS

NOTE1: I have not tested this.

NOTE2: There is a note on the download page that reads:

Not compatible with macOS Monterey

1. Unpack the .tgz file.
2. Instructions from the README.txt:
   1. Open Leap_Motion_Installer_version.dmg
   2. Run Leap Motion.pkg

Libraries for java applications

The files that you will need for java applications are located in:

• LeapSDK/lib:
  • LeapJava.jar
  • libLeap.dylib
  • libLeapJava.dylib

Copy these to the lib directory that the java application specifies.