# Intel® RealSense™ ID Python SDK
Intel RealSense ID is your trusted facial authentication on-device solution.
Intel RealSense ID combines an active depth sensor with a specialized neural network designed to deliver an intuitive, secure and accurate facial authentication solution that adapts over time. This solution offers user privacy and is activated by user awareness. Built-in anti spoofing technology protects against attacks using photographs, videos or masks.
Intel RealSense ID is a natural solution simplifying secure entry for everyone, everywhere. Supports children to tall adults and designed for Smart Locks, Access Control, PoS, ATMs, and Kiosks.
Developer kits containing the necessary hardware to use this library are available for purchase at store.intelrealsense.com. See information about the Intel RealSense ID technology at https://www.intelrealsense.com/facial-authentication/
For high-level architecture, see Intel RealSense ID F450 / F455 Architecture Diagram.
Note: Device = Intel RealSense ID F450 / F455
## Installation
You should install the version that matches the firmware version currently running on the device. Please refer to the RealSenseID releases page:
https://github.com/IntelRealSense/RealSenseID/releases
```
pip install realsenseid==<version>
```
### Code samples
For a full listing of samples, please refer to: https://github.com/IntelRealSense/RealSenseID/tree/master/samples/python
Authentication:
```python
import rsid_py
PORT='COM9'
def on_result(result, user_id):
print('on_result', result)
if result == rsid_py.AuthenticateStatus.Success:
print('Authenticated user:', user_id)
def on_faces(faces, timestamp):
print(f'detected {len(faces)} face(s)')
for f in faces:
print(f'\tface {f.x},{f.y} {f.w}x{f.h}')
if __name__ == '__main__':
with rsid_py.FaceAuthenticator(PORT) as f:
f.authenticate(on_faces=on_faces, on_result=on_result)
```
User Enrollment:
```python
import rsid_py
PORT='COM9'
def on_result(result):
print('on_result', result)
def on_progress(p):
print(f'on_progress {p}')
def on_hint(h):
print(f'on_hint {h}')
def on_faces(faces, timestamp):
print(f'detected {len(faces)} face(s)')
for f in faces:
print(f'\tface {f.x},{f.y} {f.w}x{f.h}')
if __name__ == '__main__':
with rsid_py.FaceAuthenticator(PORT) as f:
user_id = input("User id to enroll: ")
f.enroll(user_id=user_id, on_hint=on_hint, on_progress=on_progress, on_faces=on_faces, on_result=on_result)
#display list of enrolled users
users = f.query_user_ids()
print('Users: ', users)
```
## Legal
Copyright © 2018-2024 Intel Corporation
> LEGAL NOTICE: Your use of this software and any required dependent software (the “Software Package”) is subject to the terms and conditions of the Apache 2.0 License for the Software Package, which may also include notices, disclaimers, or license terms for third party or open source software included in or with the Software Package, and your use indicates your acceptance of all such terms. Please refer to the “third-party-programs.txt” or other similarly-named text file included with the Software Package for additional details.
> Intel is committed to the respect of human rights and avoiding complicity in human rights abuses, a policy reflected in the Intel Global Human Rights Principles. Accordingly, by accessing the Intel material on this platform you agree that you will not use the material in a product or application that causes or contributes to a violation of an internationally recognized human right.
Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.
Raw data
{
"_id": null,
"home_page": "https://github.com/IntelRealSense/RealSenseID",
"name": "realsenseid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "intel, realsense, realsenseid, facial-authentication",
"author": "Intel(R) Corporation",
"author_email": "\"Intel(R) Corporation\" <realsenseid@intel.com>",
"download_url": "https://github.com/IntelRealSense/RealSenseID/releases",
"platform": null,
"description": "# Intel\u00ae RealSense\u2122 ID Python SDK\n\nIntel RealSense ID is your trusted facial authentication on-device solution.\n\nIntel RealSense ID combines an active depth sensor with a specialized neural network designed to deliver an intuitive, secure and accurate facial authentication solution that adapts over time. This solution offers user privacy and is activated by user awareness. Built-in anti spoofing technology protects against attacks using photographs, videos or masks.\n\nIntel RealSense ID is a natural solution simplifying secure entry for everyone, everywhere. Supports children to tall adults and designed for Smart Locks, Access Control, PoS, ATMs, and Kiosks.\n\nDeveloper kits containing the necessary hardware to use this library are available for purchase at store.intelrealsense.com. See information about the Intel RealSense ID technology at https://www.intelrealsense.com/facial-authentication/\n\nFor high-level architecture, see Intel RealSense ID F450 / F455 Architecture Diagram.\n\nNote: Device = Intel RealSense ID F450 / F455\n\n\n\n## Installation\n\nYou should install the version that matches the firmware version currently running on the device. Please refer to the RealSenseID releases page:\nhttps://github.com/IntelRealSense/RealSenseID/releases \n\n```\npip install realsenseid==<version>\n```\n\n### Code samples\n\nFor a full listing of samples, please refer to: https://github.com/IntelRealSense/RealSenseID/tree/master/samples/python\n\nAuthentication:\n\n```python\nimport rsid_py\n\nPORT='COM9'\n\ndef on_result(result, user_id):\n print('on_result', result) \n if result == rsid_py.AuthenticateStatus.Success:\n print('Authenticated user:', user_id)\n\ndef on_faces(faces, timestamp): \n print(f'detected {len(faces)} face(s)')\n for f in faces:\n print(f'\\tface {f.x},{f.y} {f.w}x{f.h}') \n\nif __name__ == '__main__':\n with rsid_py.FaceAuthenticator(PORT) as f:\n f.authenticate(on_faces=on_faces, on_result=on_result)\n```\n\nUser Enrollment:\n\n```python\nimport rsid_py\n\nPORT='COM9'\n\ndef on_result(result):\n print('on_result', result) \n\ndef on_progress(p): \n print(f'on_progress {p}')\n\ndef on_hint(h): \n print(f'on_hint {h}')\n\ndef on_faces(faces, timestamp): \n print(f'detected {len(faces)} face(s)')\n for f in faces:\n print(f'\\tface {f.x},{f.y} {f.w}x{f.h}') \n\n\nif __name__ == '__main__':\n with rsid_py.FaceAuthenticator(PORT) as f:\n user_id = input(\"User id to enroll: \")\n f.enroll(user_id=user_id, on_hint=on_hint, on_progress=on_progress, on_faces=on_faces, on_result=on_result)\n\n #display list of enrolled users\n users = f.query_user_ids()\n print('Users: ', users)\n```\n\n## Legal\n\nCopyright \u00a9 2018-2024 Intel Corporation\n\n> LEGAL NOTICE: Your use of this software and any required dependent software (the \u201cSoftware Package\u201d) is subject to the terms and conditions of the Apache 2.0 License for the Software Package, which may also include notices, disclaimers, or license terms for third party or open source software included in or with the Software Package, and your use indicates your acceptance of all such terms. Please refer to the \u201cthird-party-programs.txt\u201d or other similarly-named text file included with the Software Package for additional details.\n\n> Intel is committed to the respect of human rights and avoiding complicity in human rights abuses, a policy reflected in the Intel Global Human Rights Principles. Accordingly, by accessing the Intel material on this platform you agree that you will not use the material in a product or application that causes or contributes to a violation of an internationally recognized human right.\n\nIntel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.\n\n",
"bugtrack_url": null,
"license": "OSI Approved :: Apache Software License",
"summary": "RealSenseID(TM)",
"version": "0.38.2",
"project_urls": {
"Changelog": "https://github.com/IntelRealSense/RealSenseID/releases",
"Documentation": "https://github.com/IntelRealSense/RealSenseID/blob/master/Readme.md",
"Download": "https://github.com/IntelRealSense/RealSenseID/releases",
"Homepage": "https://www.intelrealsense.com/facial-authentication/",
"Issues": "https://github.com/IntelRealSense/RealSenseID/issues",
"Repository": "https://github.com/IntelRealSense/RealSenseID"
},
"split_keywords": [
"intel",
" realsense",
" realsenseid",
" facial-authentication"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a8fc5629a1c21705f179650147b133acbf5206c444c066653cc67a56f98d3a5",
"md5": "e8d26e1dda2fb2beae475338880e21ee",
"sha256": "61b11c6a12f6e5a15068d394fa6d0236f74afa6883114c300788e02ed1995337"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp310-cp310-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "e8d26e1dda2fb2beae475338880e21ee",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 1979271,
"upload_time": "2024-10-09T20:56:10",
"upload_time_iso_8601": "2024-10-09T20:56:10.411658Z",
"url": "https://files.pythonhosted.org/packages/4a/8f/c5629a1c21705f179650147b133acbf5206c444c066653cc67a56f98d3a5/realsenseid-0.38.2-cp310-cp310-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46149f42d1c24a35700feffea76577f5131a33214cac71d144d31b1653af2520",
"md5": "cafb9fcacca588870a4e72dab639c68e",
"sha256": "57b8eb67239090bb9dbaa1192fa3d9e194610160ff5563039dc298fc12516f45"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "cafb9fcacca588870a4e72dab639c68e",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 1122645,
"upload_time": "2024-10-09T20:56:12",
"upload_time_iso_8601": "2024-10-09T20:56:12.971090Z",
"url": "https://files.pythonhosted.org/packages/46/14/9f42d1c24a35700feffea76577f5131a33214cac71d144d31b1653af2520/realsenseid-0.38.2-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "280c4d2980de585a4998252f05dfa135b20fe664c237b95d82a8684f58cccdc9",
"md5": "96fb4934c4aa5fa09fe2cd6968ab58f8",
"sha256": "0bf58801cb1558bdcc5f126335dead7376c31ae59a6309aefefb70dfe7b08788"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp311-cp311-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "96fb4934c4aa5fa09fe2cd6968ab58f8",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.10",
"size": 1980911,
"upload_time": "2024-10-09T20:56:14",
"upload_time_iso_8601": "2024-10-09T20:56:14.851875Z",
"url": "https://files.pythonhosted.org/packages/28/0c/4d2980de585a4998252f05dfa135b20fe664c237b95d82a8684f58cccdc9/realsenseid-0.38.2-cp311-cp311-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "693e3aa30cbbc07087aa6b32c1aa56b04e5ff1970257f7b3a41019e11d26ebc5",
"md5": "1708ee2bdf2537d628fc63449c364fc0",
"sha256": "d0c12acc4ceb54da95bbd718ffe7fccd3a1276fd7e5d41ca7935501feaa96b16"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "1708ee2bdf2537d628fc63449c364fc0",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.10",
"size": 1123613,
"upload_time": "2024-10-09T20:56:16",
"upload_time_iso_8601": "2024-10-09T20:56:16.538405Z",
"url": "https://files.pythonhosted.org/packages/69/3e/3aa30cbbc07087aa6b32c1aa56b04e5ff1970257f7b3a41019e11d26ebc5/realsenseid-0.38.2-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ec37da3ed0b23b58e7e8e3fa8eadc43777f5e639a1f0b4ffc09cb36e2115f31",
"md5": "97c0db3c553cf533c92bd3d52e6669d3",
"sha256": "75aa47c6cafb0b6343e139303d5c1e92be4d20a29bf1f9f12c457a2b339f8008"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp312-cp312-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "97c0db3c553cf533c92bd3d52e6669d3",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.10",
"size": 1981922,
"upload_time": "2024-10-09T20:56:18",
"upload_time_iso_8601": "2024-10-09T20:56:18.323500Z",
"url": "https://files.pythonhosted.org/packages/5e/c3/7da3ed0b23b58e7e8e3fa8eadc43777f5e639a1f0b4ffc09cb36e2115f31/realsenseid-0.38.2-cp312-cp312-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e40bd8b646d4cd5af95088a3de36d010e2dfc7c6f42a66e3b4c664864ecadc51",
"md5": "430c360a414443b5d7be396d091a8d56",
"sha256": "afa8a4ecae5a2487d6a8c71e76ed11553b0c471ff1db42d5b8e6e5f991067244"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "430c360a414443b5d7be396d091a8d56",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.10",
"size": 1122593,
"upload_time": "2024-10-09T20:56:19",
"upload_time_iso_8601": "2024-10-09T20:56:19.897570Z",
"url": "https://files.pythonhosted.org/packages/e4/0b/d8b646d4cd5af95088a3de36d010e2dfc7c6f42a66e3b4c664864ecadc51/realsenseid-0.38.2-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15cfa1b1517d2ebd766e30ebad19d4f6e45952f71c257b410ee4ceea478b0754",
"md5": "9f297a7b1d56503e79cfa5ac224d3f33",
"sha256": "b49066d6cc631c4ab647cb99a09c376c410ffa7126ecf9a0a113d9dcb961fdeb"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp313-cp313-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "9f297a7b1d56503e79cfa5ac224d3f33",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.10",
"size": 1981962,
"upload_time": "2024-10-09T20:56:21",
"upload_time_iso_8601": "2024-10-09T20:56:21.795987Z",
"url": "https://files.pythonhosted.org/packages/15/cf/a1b1517d2ebd766e30ebad19d4f6e45952f71c257b410ee4ceea478b0754/realsenseid-0.38.2-cp313-cp313-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ae57b21ef85d19d19bec40cadc7987e29948295b4eb0d0fdc13c62156244414e",
"md5": "4e6371e02d52e96a888b7856b833fcb5",
"sha256": "ed70f93512c02af30f5939744863ee74261d623a1f057d0dbab0bceb7e0cd41c"
},
"downloads": -1,
"filename": "realsenseid-0.38.2-cp313-cp313-win_amd64.whl",
"has_sig": false,
"md5_digest": "4e6371e02d52e96a888b7856b833fcb5",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.10",
"size": 1122554,
"upload_time": "2024-10-09T20:56:23",
"upload_time_iso_8601": "2024-10-09T20:56:23.778786Z",
"url": "https://files.pythonhosted.org/packages/ae/57/b21ef85d19d19bec40cadc7987e29948295b4eb0d0fdc13c62156244414e/realsenseid-0.38.2-cp313-cp313-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 20:56:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IntelRealSense",
"github_project": "RealSenseID",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "realsenseid"
}
JSON
