add new Rest api wrapper #13965

ArthurRaizIntel · 2025-04-28T07:31:03Z

Tracked on [LRS-1272]

Copilot

Pull Request Overview

This PR adds a new REST API wrapper for interacting with RealSense devices and WebRTC streaming by introducing various endpoints and supporting code.

Adds core security functions and placeholder implementations for token creation and password hashing.
Introduces several API endpoints for devices, sensors, streams, point cloud, options, and WebRTC communications.
Provides dependency injection for service managers and updates documentation to include the new REST API wrapper.

Reviewed Changes

Copilot reviewed 38 out of 39 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
app/core/security.py	Introduces token creation and password verification placeholders
app/core/errors.py	Adds custom error handlers for various FastAPI exceptions
app/core/config.py	Provides settings retrieval with an lru_cache decorator
app/core/auth.py	Implements basic authentication logic with a fake user database
app/api/router.py	Configures API routing to include various endpoint modules
app/api/endpoints/*	Implements endpoints for webrtc, streams, sensors, point cloud, options, and devices
app/api/dependencies.py	Supplies singleton dependencies for RealSense and WebRTC managers
wrappers/rest-api/README.md & wrappers/readme.md	Updates documentation to document the new REST API capabilities

Files not reviewed (1)

wrappers/rest-api/.gitignore: Language not supported

Comments suppressed due to low confidence (1)

wrappers/rest-api/app/api/endpoints/point_cloud.py:32

Consider renaming 'get_stream_status' to 'get_point_cloud_status' for consistency with the underlying service call.

async def get_stream_status(

Nir-Az · 2025-04-29T12:44:34Z

wrappers/rest-api/README.md

+# LibRS Rest API server
+## Overview
+
+This Python library provides a convenient wrapper to interact with the [RealSense REST API], a FastAPI-based service that exposes the functionality of the Intel RealSense SDK (librealsense) over a network.


This was the meaning here or missing some symbol?

I just wanted to emphasize it

Nir-Az · 2025-04-29T12:45:54Z

wrappers/rest-api/README.md

+1.  **RESTful Operations:** For device discovery, configuration, and control.
+2.  **WebRTC:** For efficient, browser-compatible live video streaming (RGB, Depth).
+3.  **Socket.IO:** For real-time streaming of frame metadata and point cloud data.
+    * In order to decode point cloud data in the client, follow those steps:


Maybe we can add a python or other language you already did it on code snippet?

I dont have something official I can provide. it just a standard and languege agnostic socketio usage.

Nir-Az · 2025-04-29T12:48:16Z

wrappers/rest-api/app/core/auth.py

+fake_users_db = {
+    "admin": {
+        "username": "admin",
+        "hashed_password": "$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga31lW",  # "password"


What is this password?

just placeholders for future use in case password authentication will be required in the rest api

Nir-Az · 2025-04-29T12:49:04Z

wrappers/rest-api/app/core/security.py

+from typing import Any, Optional
+
+# from jose import jwt
+#from passlib.context import CryptContext


This 2 commented lines are needed?

just placeholders for future use in case password authentication will be required in the rest api

Nir-Az · 2025-04-29T12:49:34Z

wrappers/rest-api/app/core/security.py

+
+from app.core.config import get_settings
+
+#pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")


Same for all other commented out lines in this file

same answer :)
I can remove but then it will be little bit more dificult to find it in the future.

Nir-Az · 2025-04-29T12:51:03Z

wrappers/rest-api/tests/setup_fake_devices.py

+from time import time
+from .pyrealsense_mock import context, create_mock_device
+
+# # Global variables for frame generation


What is all of this commented out code?

testing code, will remove.

Nir-Az · 2025-04-29T14:28:10Z

wrappers/rest-api/app/services/rs_manager.py

+                    physical_port = None
+
+                try:
+                    usb_type = dev.get_info(rs.camera_info.usb_type_descriptor)


I suggest to wrap each get info with (dev.supports()) condition,
Here for example it will fail for MIPI devices as they do not support USB_type
I am not sure if it will throw

np. will check it.

AviaAv · 2025-04-29T15:33:51Z

wrappers/rest-api/start_server.sh

+#!/bin/bash
+
+# Start the FastAPI server
+uvicorn main:combined_app --host 0.0.0.0 --port 8000


There's an option to do --reload for a fast reload, maybe adding it will make working on the wrapper easier?

the reload is a flag for debugging purposes. not needed for regular usage.

AviaAv · 2025-04-29T15:39:41Z

wrappers/rest-api/README.md

+    *   Establish a Socket.IO connection to the API.
+    *   Receive real-time events containing:
+        *   Frame metadata (timestamps, frame numbers, etc.).
+        *   Point cloud data streams.


Might be helpful to mention that all of the endpoints and the supported features are available on the /docs endpoint

I was pretty sure I added it, probably missed that. will add.

AviaAv · 2025-05-05T06:56:38Z

wrappers/rest-api/app/services/rs_manager.py

+                                        points = self.pc.calculate(frame_data)
+                                elif stream_type == rs.stream.color.name:
+                                    frame_data = frames.get_color_frame()
+                                    frame = frame_data.get_data()


Can we support pointcloud with color stream with self.pc.map_to ?

AviaAv · 2025-05-05T07:24:58Z

wrappers/rest-api/tests/mock_dependencies.py

+    This fixture will automatically be used in all tests.
+    """
+    # Create mock instances
+    rs_manager = RealSenseManager()


Shouldn't we initialize sio and do RealSenseManager(sio) ?

AviaAv · 2025-05-05T07:37:10Z

wrappers/rest-api/app/models/device.py

+    firmware_version: Optional[str] = None
+    physical_port: Optional[str] = None
+
+class DeviceCreate(DeviceBase):


What's this class? Seeing this on the other models too

AviaAv · 2025-05-05T08:11:54Z

We also need to add License and Copyright on some of the files

# License: Apache 2.0. See LICENSE file in root directory.
# Copyright(c) 2025 Intel Corporation. All Rights Reserved.

AviaAv · 2025-05-05T08:34:14Z

wrappers/rest-api/app/services/rs_manager.py

if device_id not in self.devices: self.refresh_devices() if device_id not in self.devices: raise RealSenseError( status_code=404, detail=f"Device {device_id} not found" )

I see this code (or similar variations) are repeated multiple times in the code, let's use get_device or a new helper function

Nir-Az · 2025-05-18T06:50:42Z

@ArthurRaizIntel can we progress here?
We want it merged in the next release

ArthurRaizIntel added 2 commits April 28, 2025 10:28

create new rest api wrapper

c3ddfde

fix wrappers readme - add rest api description

a9e83b5

Nir-Az requested a review from Copilot April 28, 2025 08:02

Copilot AI reviewed Apr 28, 2025

View reviewed changes

Nir-Az reviewed Apr 29, 2025

View reviewed changes

Nir-Az requested a review from AviaAv April 29, 2025 14:25

Nir-Az reviewed Apr 29, 2025

View reviewed changes

AviaAv reviewed Apr 29, 2025

View reviewed changes

AviaAv reviewed May 5, 2025

View reviewed changes


		from app.core.config import get_settings

		#pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")

add new Rest api wrapper #13965

Are you sure you want to change the base?

add new Rest api wrapper #13965

Uh oh!

Conversation

ArthurRaizIntel commented Apr 28, 2025 • edited by Nir-Az Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AviaAv May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AviaAv commented May 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nir-Az commented May 18, 2025

Uh oh!

Uh oh!

ArthurRaizIntel commented Apr 28, 2025 •

edited by Nir-Az

Loading

AviaAv May 5, 2025 •

edited

Loading