{"id":27598715,"url":"https://github.com/intelrealsense/realsenseid-rest","last_synced_at":"2025-09-11T14:18:16.868Z","repository":{"id":284601793,"uuid":"814699947","full_name":"IntelRealSense/RealSenseID-REST","owner":"IntelRealSense","description":"Using RealSenseID Python bindings to bring remote access and control capabilities to the F4xx device families.","archived":false,"fork":false,"pushed_at":"2025-04-08T14:48:51.000Z","size":1263,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-08T15:30:44.426Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IntelRealSense.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-13T14:20:26.000Z","updated_at":"2025-04-08T14:46:17.000Z","dependencies_parsed_at":"2025-03-26T18:48:06.826Z","dependency_job_id":null,"html_url":"https://github.com/IntelRealSense/RealSenseID-REST","commit_stats":null,"previous_names":["intelrealsense/realsenseid-rest"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelRealSense%2FRealSenseID-REST","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelRealSense%2FRealSenseID-REST/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelRealSense%2FRealSenseID-REST/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelRealSense%2FRealSenseID-REST/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntelRealSense","download_url":"https://codeload.github.com/IntelRealSense/RealSenseID-REST/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250258558,"owners_count":21400928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-22T14:29:31.369Z","updated_at":"2025-04-22T14:29:38.177Z","avatar_url":"https://github.com/IntelRealSense.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReadSenseID-REST \n\nThis software aims to providing REST and WebSocket interface to the RealSenseID library. \nIt is meant to be a kickstarter for projects that utilize RealSenseID with remote access.\n\n## Pre-requisites\n\n- Python 3.10+ (All the way to Python 3.12)\n\n## Installation - First Time\n\nPrepare a virtual environment:\n\nNote: If you're on Ubuntu, and it complains about `pip` not available, run this:  \n```shell\nsudo apt install -y python3-pip\n```\n\nStandard installation:\n\nFirst time only (Linux \u0026 Windows):\n```shell\npython3 -m pip install poetry         # Install poetry\npoetry install                        # Install requirements\n```\n\nOr you can use the official poetry installer: https://python-poetry.org/docs/#installing-with-the-official-installer\nand then:\n```shell\npoetry install                        # Install requirements\n```\n\n## Update / Run\n\nUpdate Packages (Linux \u0026 Windows):\n```shell\npoetry install                        # Install / Update requirements\n```\n\nThen everytime you need to run:\n```shell\npoe run\n```\nor\n```shell\npoetry run fastapi run rsid_rest/main.py \n```\nor\n```shell\npoetry run python3 -m uvicorn rsid_rest.main:app --reload\n```\n\n## Usage\n### API Documentation\nPoint your browser to: http://127.0.0.1:8000/docs/\n### Sample Frontend\nPoint your browser to: http://127.0.0.1:8000/gui/\n\n## Configuration and Settings\n`.env` files and environment variables can be used to configura the application. The following table shows\nthe file names for environment files.\n\n### Env files\n\n| Environment |     File      |\n|-------------|:-------------:|\n| Dev         |    `.env`     |\n| Prod        |  `prod.env`   |\n\n\n### General Settings\n\nThe following variables can be set in the `.env` files or passed as Environment Variables before starting the app. \n\n| Variable                           | Default  | Configuration                                                                                            |\n|------------------------------------|:--------:|----------------------------------------------------------------------------------------------------------|\n| `auto_detect`                      |  `True`  | Automatically detect camera on system. Useful in dev environments                                        |\n| `com_port`                         |  `None`  | Specifies COM port when `auto_detect` is False. Windows example: `COM5`                                  |\n| `preview_camera_number`            |   `-1`   | Camera index for preview `-1` for auto-detect                                                            |\n| `db_mode`                          | `device` | DB location: `device` or `host`                                                                          |\n\n### Host DB Mode Settings\n\nSimilar to General Settings, the following variables can be set in `.env` or in the environment variables. They are only effective if `db_mode=host`\n\n| Variable                           | Default  | Configuration                                                                                            |\n|------------------------------------|:--------:|----------------------------------------------------------------------------------------------------------|\n| `host_mode_auth_type`              | `hybrid` | In `host` DB mode: `hybrid`: use vector DB to enhance performance or: `device`: only use device matcher. |\n| `host_mode_hybrid_max_results`     |   `10`   | In `host` and `hybrid`: Vector DB filters should filter for a max of X candidates                        |\n| `host_mode_hybrid_score_threshold` |  `0.2`   | In `host` and `hybrid`: Vector DB filters should filter use this score threshold (keep low)              |\n\n\n### Streaming Settings\n\nSimilar to General Settings, the following variables can be set in `.env` or in the environment variables.\n\n| Variable                           | Default  | Configuration                                                                                            |\n|------------------------------------|:--------:|----------------------------------------------------------------------------------------------------------|\n| `preview_stream_type`              |  `jpeg`  | Streaming Preview output: `jpeg` or `webp`                                                               |\n| `preview_jpeg_quality`             |   `85`   | Streaming Preview JPEG quality. Min: `1`     Max: `100`                                                  |\n| `preview_webp_quality`             |   `85`   | Streaming Preview WebP quality. Min: `1`     Max: `100`                                                  |\n\n\n### Creating a Client using the OpenAPI Schema\nRunning the following command will generate `openapi.json` file that can be used with the OpenAPI generator\n```shell\npoe gen-openapi\n```\nNavigate to: https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#overview to find out more about\nthe ability to automatically generate SDK that can use this API.\n\n---\n## Important Note\n\u003e End-user is responsible for providing the authentication and security mechanisms to protect access to the camera and RealSenseID API.\n\u003e Please refer to https://fastapi.tiangolo.com/tutorial/security/ for documentation on how to integrate authentication.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintelrealsense%2Frealsenseid-rest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintelrealsense%2Frealsenseid-rest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintelrealsense%2Frealsenseid-rest/lists"}