Input Action Events can now be sent to HTML elements at the position of the cursor, making it easier to build reactive content
TouchFree Tooling clients can request updates to the config files via the service to make global changes to the TouchFree configuration for all clients
TouchFree service state can be queried
Bug Fixes:
NONE events are now properly culled from overfilled InputAction Queues, improving performance
Web Tooling cursor position now aligns correctly with scaled displays
Cursor position no longer needs to be inverted in the Y axis every time it's used
NOTE: If you have used TouchFree cursor data directly, you will need to update your code to remove the inversion of the Y Axis data
Hand tracking improvements in Screentop tracking mode: We’ve made tracking improvements to pointing pose detection at longer distances. This increases the reliability of our TouchFree solutions.
Tracking Visualizer improvements: We’ve added help text popups to various menu options to help users understand what they are for.
Tracking Mode persists on device and service reconnection: The selected tracking mode will now persist on device and service reconnection on a per-device basis, instead of resetting to the default tracking mode. For example, if a user selects HMD (head-mounted) tracking mode and disconnects that device, when the device is reconnected, HMD mode will remain as the selected tracking mode for any client connected to the service.
Note: Please uninstall previous versions of the Tracking Software to ensure there are no conflicts.
Resolved Issues
The skeleton hands overlay is no longer misaligned in the Tracking Visualizer when swapping between camera devices.
We have improved the ‘look and feel’ of the Tracking Visualizer and included some new customizable features: We’ve added a new UI to the Visualizer so that a user is able to easily control how hands are being displayed and tracked, which makes it easier for a user to troubleshoot why tracking isn’t performing as expected.
For VR users, the Visualizer can now be configured to be viewed either on their standard displays or directly in their headset.
Data analytics: We’ve integrated diagnostic data analytics. Anonymized app and usage data will be sent to Ultraleap to improve future releases. You can choose to stop sharing this anonymized data with us at any time by unchecking the "Help Improve Tracking" box in the Control Panel.
Note: Please uninstall previous versions of the Tracking Software to ensure there are no conflicts.
Resolved Issues
There are no longer compatibility issues when using the Tracking Visualizer in VR mode with the Oculus Quest 2 or Valve Index and Ultraleap cameras.
There is no longer a small offset with skeleton hand overlay in Tracking Visualizer when using SIR170 in non-VR mode.
Tracking Visualizer render fps value will now match monitor refresh rate even when window is minimised and frame rate of the VR headset when in VR.
There is no longer a memory leak in Tracking Visualizer application when tracking is paused.
LeapPollConnection will now work as expected when passing in a long timeout.
The Pause tracking feature will now work regardless of whether or not a client application is connected.
The service should no longer crash/stop when disconnecting a Leap Motion Controller or Stereo IR 170.
Tracking Visualizer does not default to Desktop mode when launched: Launching the Tracking Visualizer does not automatically set the tracking mode to Desktop. It will first display the tracking mode that has already been set by another application (e.g. TouchFree). Pressing “V” to cycle through the tracking modes will still make changes to the tracking mode used by the tracking service.
Software log rotation: Log rotation is now setup so that the most recent logs are in tracker_log.txt followed by tracker_log.1.txt , tracker_log.2.txt and tracker_log.3.txt
API update: The PID identification for the Stereo IR 170 Hand Tracking Camera has been updated. The Stereo IR 170 will now return an identification of eLeapDevicePID_SIR170 in the LEAP_DEVICE_INFO structure, rather than eLeapDevicePID_Rigel.
Note: Please uninstall previous versions of the Tracking Software to ensure there are no conflicts.
Resolved Issues
Missing VC redistributable dlls no longer causes the following installation error “The code execution cannot proceed because VCRUNTIME140_1.dll cannot be found”.
LeapPollConnection() now respects the timeout parameter value prior to a connection to the service where the timeout is always at 2 seconds (OS timeout on Windows).
Tracking service no longer crashes/stops after a firmware update to the Leap Motion Controller.
Software log file (tracker_log.txt) no longer grows indefinitely.
The serial number reported by the Leap Motion Controller is no longer displaying incorrectly.
The Control Panel now launches from Start Menu.
Occasionally, the Tracking Service can get stuck if stopped or restarted whilst the Tracking Visualizer is open. This has now been resolved.
Tracking service no longer fails to run hand tracking if the Windows username included non-Latin characters (i.e. non-ASCII).
Version 4.9.1 of the Unity Modules is only intended to be used with Version 5.2 of the tracking service (or more recent releases), it is not backwards compatible with previous service releases. For details about service compatibility with Unity Modules and how to upgrade projects, consult the Migration Guide.
32-bit support has been dropped as it is no longer supported by the V5.2 tracking service
To use V5.2 you must upgrade your project to this version of the Unity modules.
The documentation and API reference has been upgraded for branding and to reflect changes to the modules.
A new tracking mode setting has been added to the LeapServiceProvider to disable setting a tracking mode on start. If set, the (current) service tracking mode is left unchanged by the application when it connects to the service.
The scripts have been changed to switch to using the Unity pose class, retiring the Leap pose class. A number of extension methods have been added to the Unity pose class to create a similar public API to the retired class.
Bug fixes:
The version number in Core (Version.txt) has been updated to the correct version.
Some deprecated Unity enumeration values have been removed from the scripts.
Minor changes have been made to improve Unity 2020 support. However, Unity 2020 is not officially supported by this release.
Smaller editor window size for hands module
Fixed memory leak with MemoryManager using V5.2 tracking service where MemoryManager was hanging onto (image) buffers even when pooling was off.
Turned on memory pooling in MemoryManager to reduce memory churn in apps with image streaming enabled (with V5.2 tracking service).
Switched image buffers in memory manager to use a ConcurrentDictionary to prevent corruption in scenes with multiple LeapServiceProviders with V5.2 tracking service.
Known Issues:
A set of ghost / floating hands is sometimes seen on scene startup. They may appear for a for a small interval <2s before correct tracking starts. This is not seen consistently and has been observed behaviour with previous releases.
The infrared viewer shader does not render correctly in both eyes with headsets / plugins that do not support multi pass rendering - e.g. Windows Mixed Reality.
Infrared Viewer scenes sometimes display the image upside down, this is only an issue during the editor and will not exist in builds.
Some of the interaction engine demo scenes (with interactable objects - e.g. interaction objects) do not initialise the player position at the correct height (e.g. for a seated user). The position of the camera has to be adjusted in the scene view or adjusted on the scene components (the XRHeightOffset script). The magnitude of the height adjustment seems to vary depending on the headset. Behaviour is better for a standing experience. This is mainly seen when using the new Unity XR Plugin system - e.g. with Unity 2019.4. This is not officially supported by this release.
Improved stability during initialization and termination
Improved hand rotation sensitivity — especially for fists
Performance for small and large hands noticeably improved
Improved smoothness
Maximum tracking velocity decreased for certain palm orientations
Some decrease in depth calibration accuracyon Stereo IR 170
Some decrease in stability when pinching through rotations
DESKTOP MODE
Significantly more robust and accurate hand tracking
Two hand performance noticeably improved
Improved hand tracking initialization - especially for fists
Arm accuracy and stability improved
Improved high angle tracking
Improved distance tracking
Improved performance for small and large hands
Improved hand rotation performance
Improved smoothness
Decreased pinky fidelity
Decreased single finger isolated performance
Some decrease in depth calibration accuracy on Stereo IR 170
REMOVED FEATURES
Launch on Startup: This option has been removed. The Control Panel-Tray Icon will automatically be enabled to launch at Windows startup. To disable this, go to Task Manager > Start-up > Ultraleap Tracking Control Panel and right-click to disable.
Automatic power saving: This feature has been removed as it is more relevant to mobile applications.
Robust mode: This feature has been removed.
Low Resource mode: This feature has been removed.
Avoid Poor Performance: This feature has been removed.
AppHome: This has been removed from the installer. The Leap Motion App Store is obsolete.
LeapJS and WebSocket server: The WebSocket server is not supported in this version.
Auto-orient camera feed: Auto-orientation of the camera feed for tracking has been removed.
API AND SDK SPECIFIC UPDATES
LeapC API remains backwards compatible with past 4.x.x releases and the 5.0.0-preview/5.0.1-preview release. However, the client-server protocol has been replaced since 5.2. Client applications will need updating to the new 5.2 LeapC.dll when using the 5.2 tracking service. Client applications built with past 4.x.x SDKs and the 5.0.0-preview/5.0.1-preview SDKs will not communicate with 5.2 service or vice versa.
The tracking service now supports a new tracking mode – Above Facing User.
LeapC API allows setting the tracking mode via LeapSetTrackingMode() and the corresponding enum eLeapTrackingMode. Available tracking mode enumerations are eLeapTrackingMode_Desktop, eLeapTrackingMode_HMD and eLeapTrackingMode_ScreenTop, for the operation of up-facing, head-mounted, and down-facing devices.
Setting of tracking mode is confirmed by a new asynchronous event type LEAP_TRACKING_MODE_EVENT. Note that changing the tracking mode also results in LEAP_POLICY_EVENT prior to the corresponding LEAP_TRACKING_MODE_EVENT emitted via LeapPollConnection().
The tracking mode related policy flags eLeapPolicyFlag_OptimizeHMD and eLeapPolicyFlag_OptimizeScreenTop can be used to switch the tracking mode but are marked deprecated. The new LeapSetTrackingMode() function is strongly recommended over using policy flags.
The number of supported eLeapDeviceStatus enumeration values have been reduced. Device events will only contain the values: eLeapDeviceStatus_Streaming, eLeapDeviceStatus_Paused and eLeapDeviceStatus_UnknownFailure. Support for eLeapDeviceStatus_Smudged, eLeapDeviceStatus_Robust and eLeapDeviceStatus_LowResource may be reintroduced in future releases.
The service configuration file format has been changed and now read from %ProgramData%/Ultraleap/HandTracker/config.json. Previous config locations were %USERPROFILE%/AppData/Roaming/Leap Motion/config.json and %ProgramData%/Leap Motion/config.json.
The LeapSaveConfigValue() and LeapRequestConfigValue() functions are currently provided as no-op implementations and included for compile time backwards compatibility. We expect these functions to be reintroduced in a future releases. Similarly the LeapPollConnection() events LEAP_CONFIG_RESPONSE_EVENT and LEAP_CONFIG_CHANGE_EVENT will not be generated.
The LeapInterpolateHeadPose(), LeapGetPointMappingSize() and LeapGetPointMapping() functions have been replaced with no-op implementations and only included for compile time backwards compatibility. We expect to remove these functions in future versions of the software. Similarly the LeapPollConnection() events LEAP_HEAD_POSE_EVENT and LEAP_POINT_MAPPING_CHANGE_EVENT will no longer be generated.
The LeapPollConnection() events LEAP_LOG_EVENT and LEAP_LOG_EVENTS will no longer be generated. Logging is handled by the service writing directly to log files.
Some experimental Ex functions have been added to support specifying camera devices, such as LeapPixelToRectilinearEx() . These are currently for internal use.
KNOWN ISSUES
Missing VC redistributable dlls causes the following installation error “The code execution cannot proceed because VCRUNTIME140_1.dll cannot be found”. This can be solved by installing the latest VC redistributables from here (x64 for Visual Studio 2015, 2017, 2019, and 2022) and re-running the installer.
Tracking does not resume when the Windows OS awakes from a hibernated shutdown (i.e. “sleep” mode). This includes the Fast Startup feature in Windows 10 as that will put the computer in a hibernated state instead of performing a full shutdown.
LeapPollConnection() does not respect the timeout parameter value prior to a connection to the service where the timeout is always at 2 seconds (OS timeout on Windows). It does respect the timeout once connected.
Occasionally, disconnecting an Ultraleap Hand Tracking Camera causes the Tracking Service to crash/stop. The service should restart automatically, but a manual service restart may be required to resume tracking.
Tracking Service can crash/stop after a firmware update to the Leap Motion Controller and raise an error message. The service should restart automatically, but a manual service restart and/or connecting and disconnecting may be required to reset the service and resume tracking.
Hands can be seen to drift in the Visualizer when the tracking has been paused or during a tracking mode change. The server stops sending new data, however the LeapC.dll client code still continues to extrapolate hand positions from progressively older data.
Skeleton hands overlay on the camera image can be seen to misalign in the Tracking Visualizer when swapping between camera devices as the Visualizer does not update to use a new calibration value. This currently can be resolved by closing and re-opening the Visualizer.
Software log file (tracker_log.txt) will grow indefinitely. Depending on usage, this would average at about 2MB per day.
Occasionally, there will be missed notifications that Leap Motion Controller is in the process of a firmware upgrade. There will still be a notification that the upgrade has occurred.
The serial number reported by Leap Motion Controller is displaying incorrectly.
Compatibility issues when using the Tracking Visualizer in VR mode with the Oculus Quest 2 and Leap Motion Controller. Camera images are seen but no tracking. Disconnecting and reconnecting the Leap Motion Controller resolves the issue. Also, when the proximity sensor is not active (i.e. the headset is not worn), the Tracking Visualizer will display a black screen and have issues with displayed text.
Compatibility issues when using the Tracking Visualizer in VR mode with the Valve Index headset and Ultraleap cameras. Skeleton hands are seen to be misaligned with the camera images.
Control Panel can briefly display old statuses on service restart. The correct status will be displayed after a few seconds.
A small offset can be seen with skeleton hand overlay in Tracking Visualizer when using Stereo IR 170 in non-VR mode. This offset is not seen in VR mode.
Occasionally, the Tracking Visualizer does not display camera images. The Tracking Service needs to be restarted.
Small memory leak (11-17MB) every time a client is connected or disconnected or when there is a change in the tracking mode. Restarting the service will set the memory usage back to its initial baseline.
Occasionally, the Control Panel 'About' tab does not refresh properly to display the correct firmware version.
Tracking Visualizer render fps value is sometimes as low as 20-30fps when minimised but displays correct value (e.g. 60fps) when maximised.
Even though the Tracking Service has restarted successfully, there is a Control Panel notification pop up informing that the Tracking Service has stopped.
Leap tracking service now supports a new Screentop tracking mode
LeapC API allows setting the tracking mode via LeapSetTrackingMode() and the corresponding enum eLeapTrackingMode. Available tracking mode enumerations are eLeapTrackingMode_Desktop, eLeapTrackingMode_HMD and eLeapTrackingMode_ScreenTop, for the operation of up-facing, head-mounted and down-facing devices.
Setting the tracking mode is confirmed by a new asynchronous event type LEAP_TRACKING_MODE_EVENT. Note that changing the tracking mode also results in LEAP_POLICY_EVENT prior to the corresponding LEAP_TRACKING_MODE_EVENT emitted via LeapPollConnection().
The tracking mode related policy flags eLeapPolicyFlag_OptimizeHMD and eLeapPolicyFlag_OptimizeScreenTop can be used to switch the tracking mode but are marked deprecated. Please use LeapSetTrackingMode() instead.
The hmd_tracking parameter specified by command line argument or in the config file of the LeapService is deprecated. The activation prevents other tracking modes to be enabled.
Removed AppHome
Two hand performance noticeably improved
Arm accuracy improved
Improved performance for small and large hands
Improved hand rotation sensitivity
Improved smoothness
Improved hand tracking initialization
Improved hand tracking termination consistency (HMD mode only)
Finger fidelity increased (HMD mode only)
Significantly more robust hand tracking (Desktop mode only)
Attention The 5.0.0-preview releases supports the same LeapC API as past 4.x.x versions and future 5.x.x versions. However, the client-server protocol will be replaced in the first non-preview 5.x.x release. This will mean that client applications built with the 5.0.x-preview SDK will not communicate with 5.x.x servers or vice versa.
Resolved issue that caused tracking latency within apps to increase over time
Fix for service crash after disconnecting/reconnecting in HMD mode
Fix for errant disk full message in App Home on Windows
KNOWN ISSUES (GENERAL)
We support the image hand in robust mode, but it is not recommended to use full-on image passthrough in bright lighting / robust mode
Pausing/Resuming Tracking can cause the FPS to drop. The workaround is to Disconnect/Reconnect the device to bring the FPS back to normal.
Bone direction vector points in the wrong direction. It should point toward the distal end of the bone.
Images cannot be extracted from serialized frames
Device.isFlipped is always false
Avast! Antivirus can interfere with Leap Motion Service installation (disable shields to work around)
Secure WebSocket (TLS) on Linux Chrome requires running with --ignore-certificate-errors (caution: this also affects non-WebSocket services)
Chrome on Windows 7 sometimes fails to respond to emulated touch points – to fix this, click inside the program with a mouse
The sphereRadius and sphereCenter functions of the Hand class are unstable when the hand is fully open
Tracking quality is lower when making a fist or with only one finger extended
Tracking may not work as well with bracelets, rings, watches, sleeves, etc
Linux does not support background apps or onFocus callbacks
KNOWN ISSUES (VR BETA)
The latest version of the Oculus firmware limits bandwidth for the DK2’s built-in USB port, which harms the controller’s performance. For now, we recommend using the free cable extender bundled with the mount to connect the controller directly to the computer.
Tracking performance may degrade when closely facing large reflective surfaces like white walls or infrared-reflective curtains. (This is a broader issue with V2 tracking that we’re constantly improving on.)
Tracking degrades when arms are held directly away from the body (i.e. elbows straight).
Some poses are not currently tracked reliably in head-mounted display (HMD) mode (e.g. pinch/rotate, 3- and 4-finger poses).
Minimized or out-of-focus applications using the HMD policy flag can affect the service state. Close such programs before switching back to non-VR apps.
Resolved issue that caused tracking latency within apps to increase over time
Fix for service crash after disconnecting/reconnecting in HMD mode
Fix for errant disk full message in App Home on Windows
KNOWN ISSUES (GENERAL)
We support the image hand in robust mode, but it is not recommended to use full-on image passthrough in bright lighting / robust mode
Pausing/Resuming Tracking can cause the FPS to drop. The workaround is to Disconnect/Reconnect the device to bring the FPS back to normal.
Bone direction vector points in the wrong direction. It should point toward the distal end of the bone.
Images cannot be extracted from serialized frames
Device.isFlipped is always false
Avast! Antivirus can interfere with Leap Motion Service installation (disable shields to work around)
Secure WebSocket (TLS) on Linux Chrome requires running with --ignore-certificate-errors (caution: this also affects non-WebSocket services)
Chrome on Windows 7 sometimes fails to respond to emulated touch points – to fix this, click inside the program with a mouse
The sphereRadius and sphereCenter functions of the Hand class are unstable when the hand is fully open
Tracking quality is lower when making a fist or with only one finger extended
Tracking may not work as well with bracelets, rings, watches, sleeves, etc
Linux does not support background apps or onFocus callbacks
KNOWN ISSUES (VR BETA)
The latest version of the Oculus firmware limits bandwidth for the DK2’s built-in USB port, which harms the controller’s performance. For now, we recommend using the free cable extender bundled with the mount to connect the controller directly to the computer.
Tracking performance may degrade when closely facing large reflective surfaces like white walls or infrared-reflective curtains. (This is a broader issue with V2 tracking that we’re constantly improving on.)
Tracking degrades when arms are held directly away from the body (i.e. elbows straight).
Some poses are not currently tracked reliably in head-mounted display (HMD) mode (e.g. pinch/rotate, 3- and 4-finger poses).
Minimized or out-of-focus applications using the HMD policy flag can affect the service state. Close such programs before switching back to non-VR apps.
Resolved issue that caused tracking latency within apps to increase over time
Fix for service crash after disconnecting/reconnecting in HMD mode
Fix for errant disk full message in App Home on Windows
KNOWN ISSUES (GENERAL)
We support the image hand in robust mode, but it is not recommended to use full-on image passthrough in bright lighting / robust mode
Pausing/Resuming Tracking can cause the FPS to drop. The workaround is to Disconnect/Reconnect the device to bring the FPS back to normal.
Bone direction vector points in the wrong direction. It should point toward the distal end of the bone.
Images cannot be extracted from serialized frames
Device.isFlipped is always false
Avast! Antivirus can interfere with Leap Motion Service installation (disable shields to work around)
Secure WebSocket (TLS) on Linux Chrome requires running with --ignore-certificate-errors (caution: this also affects non-WebSocket services)
Chrome on Windows 7 sometimes fails to respond to emulated touch points – to fix this, click inside the program with a mouse
The sphereRadius and sphereCenter functions of the Hand class are unstable when the hand is fully open
Tracking quality is lower when making a fist or with only one finger extended
Tracking may not work as well with bracelets, rings, watches, sleeves, etc
Linux does not support background apps or onFocus callbacks
KNOWN ISSUES (VR BETA)
The latest version of the Oculus firmware limits bandwidth for the DK2’s built-in USB port, which harms the controller’s performance. For now, we recommend using the free cable extender bundled with the mount to connect the controller directly to the computer.
Tracking performance may degrade when closely facing large reflective surfaces like white walls or infrared-reflective curtains. (This is a broader issue with V2 tracking that we’re constantly improving on.)
Tracking degrades when arms are held directly away from the body (i.e. elbows straight).
Some poses are not currently tracked reliably in head-mounted display (HMD) mode (e.g. pinch/rotate, 3- and 4-finger poses).
Minimized or out-of-focus applications using the HMD policy flag can affect the service state. Close such programs before switching back to non-VR apps.
TouchFree is a software application that runs on an interactive kiosk or advertising totem. It detects a user’s hand in mid-air and converts it to an on-screen cursor.
Minimum system requirements
Ultraleap Leap Motion Controller or Stereo IR 170 camera module
