ORB SLAM 3
Last updated: 1 day ago • 21 versions | Visibility: Public
Context
This article describes how to use the Lynx ORB Slam implementation optimized for compatible Qualcomm chipsets.
This version uses custom Qualcomm Hardware Accelerators for improved performance and requires to have a rooted device.
Prerequisites
- Android Studio Narwhal 2025.1.2
- Qualcomm Hexagon SDK 5.5.5.0
- Define an HEXAGON_SDK_ROOT environment variable pointing to Qualcomm Hexagon SDK path. (For Instance : C:\Qualcomm\Hexagon_SDK\5.5.5.0 )
- Rooted device (cf.
https://lynx.miraheze.org/wiki/Rooting_Process(TODO : Not 100% correct about Boot B, DO NOT USE THIS WIKI LINK BUT THE PROCESS BELOW)
Important(TODO): rooting the device is not a procedure made by Lynx and take no responsabilities to the damage caused to the device.
→ Even if the process has been successfully reproduced by the Lynx team, we do not held any responsability about the potential damages you could cause to your device because of root access.
Project setup (user build)
First, clone the project and submodules : (TODO INSERT REPO)
git clone && cd LynxOrbSlam3 && git submodule update --init --recursive
Prepare the headset
- After cloning the project, root and patch the headset to access protected hardware acceleration.
- Important: back up all important data before proceeding.
- During every step, the device is supposed to always be connected to the computer using an USB Cable.
Root the device
- Download the latest QFIL build: QFIL build
- Follow the documentation after backing up your device
- Install Magisk: Magisk releases
- Patch boot.img:
- Push boot.img to /sdcard/
- Select it in Magisk App (Use scrcpy if the device goes into 2D display mode: scrcpy)
- Pull the patched file back to your computer
- Reflash the device:
- Replace boot.img in the QFIL build, or
- Flash only boot_a + boot_b partitions
- Reinstall Magisk (preferably with the -g option)
- In the Magisk app, finish setup by tapping the prompt
- Enable shell commands:
- Run adb shell
- Type su and accept the permission on the screen
- Type exit to return
Install Magisk OverlayFS
- Download the latest release of Magisk OverlayFS: magic_overlayfs
- Push the module to /sdcard/
- Example: adb push magisk-overlayfs-release_v3.2.2-fixed.zip /sdcard/
- In Magisk + scrcpy, install the module (select the file twice)
- Reboot the device
Patch the device and create a signature
- Verify Hexagon SDK is installed and HEXAGON_SDK_ROOT is set
- Example: C:\Qualcomm\Hexagon_SDK\5.5.5.0
- Go to the setup/folder and run prepareDeviceDemoApp.bat with cmd (not PowerShell)
- It should reboot at the end automatically
Install the Lynx Slam Magisk Module
- Push setup/LynxSlamModule.zip to /sdcard/
- Install it via Magisk (same as OverlayFS)
- Reboot the device
- Verify:
- The device should reboot multiple times without crashing
- Run:
- adb shell
- su
- getenforce → must return Permissive
Use
1. Install the app with -g option.
adb install -g .apk
2. Start the application from the Lynx Launcher
Alternatively, add the -g flag to the install flags in Android Studio and run it.
Limitations
- Windows support only for now (but should be easily adaptable on Linux-based systems)
- Use of proprietary hardware acceleration requires to have rooted device
Internal note:
in “Project Setup” section should be replaced with the final github repo.
“Project Setup” add eventual magisk module or requirements.