iLiDAR

iLiDAR is an iOS application that transforms your iPhone into a powerful multi-modal visual sensor by leveraging the built-in LiDAR scanner and RGB camera. The app enables real-time streaming of both depth maps and color images to a PC server for data collection and analysis.

App Overview

iLiDAR provides an intuitive interface for capturing and streaming LiDAR depth data alongside RGB video. The app features:

• Real-time Depth Mapping: Captures high-resolution depth data using iPhone's LiDAR scanner
• Synchronized RGB Video: Records color images simultaneously with depth data
• Network Streaming: Streams data in real-time to a PC server over Wi-Fi
• Configurable Settings: Adjustable transmission frequency and depth filtering
• Server Management: Built-in IP address management for easy server connection

App Screenshots

<div align="center"> <img src="asset/homepage.jpeg" alt="iLiDAR Homepage" width="250"/> <img src="asset/setting1.jpeg" alt="iLiDAR Settings" width="250"/> <img src="asset/setting2.jpeg" alt="iLiDAR Advanced Settings" width="250"/> <p><em>Main interface, network settings, and advanced configuration</em></p> </div>

Quick Start

Device Compatibility

Only specific iPhone models equipped with LiDAR are supported. Ensure your device is listed in the supported devices list. Generally, all iPhone Pro models from iPhone 12 Pro and later, as well as the latest iPad Pro models, are supported.

Building and Installing the App

1. Open iLiDAR.xcworkspace in Xcode (macOS required)
2. Configure your development account and handle any permission requests
3. Connect your iPhone (Pro model) via USB or wirelessly
4. Build and transfer the app to your iPhone

Important: When prompted with "Allow APP to use camera" or "Allow APP to find local network devices?", select "Allow."

Setting Up the Server

1. Ensure both your iPhone and PC are connected to the same Wi-Fi network
2. Navigate to the Server directory and run:

conda create -n ilidar python=3.10 -y
conda activate
pip install -r requirements.txt

cd Server
python ios_driver.py

The server will listen on port 5678 and create an uploads folder to store incoming data. You should see:

[*] Server listening on 0.0.0.0:5678

Streaming Data

1. Open the iLiDAR app on your iPhone
2. Enter your PC's IP address (e.g., 192.168.1.10)
3. Tap "Connect" to establish the connection
4. Tap "Enable Network Transfer" to begin streaming

If successful, you'll see logs like:

[>] Received Packet - Filename: 20241208_223229_20241208_223232_76_frame000316.jpg, Type: JPG, Seq: 55, IsLast: False, Size: 1024 bytes

Note: The app cannot run on the iOS Simulator as it requires the LiDAR API, which is not available in the simulator.

Analyzing Received Data

Use the provided scripts in Server/read_depth_data.py to analyze the received depth and RGB data. Sample files are available in Server/example_data/ for testing.

Recent Updates

We release components immediately after validation to make polished code and reproducible experiments available as soon as possible. Recent updates include:

• [x] Add Homepage picture
• [x] Enhanced local processing scripts
• [x] Local IP address management
• [x] Improved network status indicators
• [x] Released iLiDAR app
• [x] Updated network support
• [x] Enhanced UI support

Customization

For detailed modification instructions, refer to the Full Tutorial.

File Naming Convention

The system follows a structured naming convention:

• Event Timestamp: Each transfer session is marked with yyyyMMdd_HHmmss
• Frame Timestamp: Individual frames use yyyyMMdd_HHmmss_SS with sequential IDs
• File Formats:
  • RGB images: [event_timestamp]_[frame_timestamp]_frame%08d.jpg. It will recount when the count reach 99,999,999.
  • Depth data: [event_timestamp]_[frame_timestamp]_frame%08d.bin. It will recount when the count reach 99,999,999.
  • Camera parameters: [event_timestamp].csv.

Performance Tuning

• Image Compression: RGB images are compressed to 0.4 quality by default. Modify DataStorage.compressionQuality based on your network conditions.
• Frame Rate: Default transmission rate is 30 FPS but you can adjust it on the settings.

Reference

This project is built upon the Apple Official Depth Camera Example.

License

This project is licensed under the MIT License - see the LICENSE file for details.