-
Notifications
You must be signed in to change notification settings - Fork 230
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1070 from jakaskerl/main
Updating SDK docs with examples
- Loading branch information
Showing
135 changed files
with
2,197 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
Sphinx==4.1.2 | ||
Sphinx==4.2.0 | ||
sphinx-rtd-theme==0.5.0 | ||
autodocsumm==0.2.10 | ||
sphinx-tabs==3.4.0 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+654 KB
depthai_sdk/docs/source/_static/images/demos/sdk_camera_control_with_NN.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+13.8 MB
depthai_sdk/docs/source/_static/images/demos/sdk_collision_avoidance.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+8.05 MB
depthai_sdk/docs/source/_static/images/demos/sdk_emotion_recognition.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+355 KB
depthai_sdk/docs/source/_static/images/demos/sdk_face_detection_color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+341 KB
depthai_sdk/docs/source/_static/images/demos/sdk_face_detection_left.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.86 MB
depthai_sdk/docs/source/_static/images/demos/sdk_preview_all_cameras.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+850 KB
depthai_sdk/docs/source/_static/images/demos/sdk_spatial_detection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+5.43 MB
depthai_sdk/docs/source/_static/images/demos/sdk_speed_calculation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+84.4 KB
depthai_sdk/docs/source/_static/images/demos/sdk_sync_multiple_outputs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+850 KB
depthai_sdk/docs/source/_static/images/demos/sdk_visualizer_callback.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+35.1 KB
depthai_sdk/docs/source/_static/images/pipelines/camera_control_with_NN.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+25.2 KB
depthai_sdk/docs/source/_static/images/pipelines/collision_avoidance.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+101 KB
depthai_sdk/docs/source/_static/images/pipelines/emotion_recognition.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+33.3 KB
depthai_sdk/docs/source/_static/images/pipelines/face_detection_color.png
Oops, something went wrong.
Binary file added
BIN
+34 KB
depthai_sdk/docs/source/_static/images/pipelines/face_detection_left.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+32 KB
depthai_sdk/docs/source/_static/images/pipelines/preview_all_cameras.png
Oops, something went wrong.
Binary file added
BIN
+33.9 KB
depthai_sdk/docs/source/_static/images/pipelines/recording_duration.png
Oops, something went wrong.
Binary file added
BIN
+31.9 KB
depthai_sdk/docs/source/_static/images/pipelines/rgb_mono_preview.png
Oops, something went wrong.
Binary file added
BIN
+26.8 KB
depthai_sdk/docs/source/_static/images/pipelines/roboflow_integration.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+56.4 KB
depthai_sdk/docs/source/_static/images/pipelines/spatial_detection.png
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+66.5 KB
depthai_sdk/docs/source/_static/images/pipelines/switch_between_models.png
Oops, something went wrong.
Binary file added
BIN
+62.9 KB
depthai_sdk/docs/source/_static/images/pipelines/sync_multiple_outputs.png
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+26.4 KB
depthai_sdk/docs/source/_static/images/pipelines/visualizer_callback.png
Oops, something went wrong.
Oops, something went wrong.
Binary file added
BIN
+25.1 KB
depthai_sdk/docs/source/_static/images/pipelines/youtube_download.png
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.. note:: | ||
Visualization in current example is done with blocking behavor. This means that the program will halt at ``oak.start()`` until the window is closed. | ||
This is done to keep the example simple. For more advanced usage, see :ref:`Blocking behavior` section. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Please run the `install script <https://github.com/luxonis/depthai/blob/main/install_requirements.py>`__ | ||
to download all required dependencies. Please note that this script must be ran from git context, so you have to download the `depthai <https://github.com/luxonis/depthai>`__ repository first and then run the script | ||
|
||
|
||
.. code-block:: python | ||
git clone https://github.com/luxonis/depthai.git | ||
cd depthai/ | ||
python3 install_requirements.py | ||
For additional information, please follow our :ref:`installation guide <Installation>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
depthai_sdk/docs/source/samples/CameraComponent/sdk_cam_ffc.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
FFC Camera Visualization | ||
======================== | ||
|
||
This example shows how to use the `Camera` component to display the camera feed from the FFC camera. | ||
|
||
For FFC, the camera board socket must be specified. In our case the cameras are connected to socket A, B and C. After setting the resolution to 1200p | ||
and downscaling using ISP to 800p, the camera feed is displayed in a window. | ||
|
||
.. include:: /includes/blocking_behavior.rst | ||
|
||
|
||
Setup | ||
##### | ||
|
||
.. include:: /includes/install_from_pypi.rst | ||
|
||
Pipeline | ||
######## | ||
|
||
.. image:: /_static/images/pipelines/cam_ffc.png | ||
:alt: Pipeline graph | ||
|
||
|
||
Source Code | ||
########### | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Python | ||
|
||
Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/cam_ffc.py>`__ | ||
|
||
.. literalinclude:: ../../../../examples/CameraComponent/cam_ffc.py | ||
:language: python | ||
:linenos: | ||
|
||
.. include:: /includes/footer-short.rst |
49 changes: 49 additions & 0 deletions
49
depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
Camera Control | ||
============== | ||
|
||
This example shows how to use DepthAI SDK to control the color camera parameters. | ||
|
||
.. code-block:: | ||
Control: key[dec/inc] min..max | ||
exposure time: I O 1..33000 [us] | ||
sensitivity iso: K L 100..1600 | ||
To go back to auto controls: | ||
'E' - autoexposure | ||
Demo | ||
#### | ||
|
||
.. image:: /_static/images/demos/sdk_camera_control.gif | ||
:alt: Camera Control Demo | ||
|
||
|
||
Setup | ||
##### | ||
|
||
.. include:: /includes/install_from_pypi.rst | ||
|
||
Pipeline | ||
######## | ||
|
||
.. image:: /_static/images/pipelines/camera_control.png | ||
:alt: Pipeline graph | ||
|
||
|
||
|
||
Source Code | ||
########### | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Python | ||
|
||
Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/camera_control.py>`__ | ||
|
||
.. literalinclude:: ../../../../examples/CameraComponent/camera_control.py | ||
:language: python | ||
:linenos: | ||
|
||
.. include:: /includes/footer-short.rst |
41 changes: 41 additions & 0 deletions
41
depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control_with_nn.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Camera Control with NN | ||
===================== | ||
|
||
This example shows how to set up control of color camera (focus and exposure) to be controlled by NN. The NN is a face detection model which passes detected face | ||
bounding box to camera component run auto focus and auto exposure algorithms on. | ||
|
||
.. include:: /includes/blocking_behavior.rst | ||
|
||
Demo | ||
#### | ||
|
||
.. image:: /_static/images/demos/sdk_camera_control_with_NN.png | ||
:alt: Control with NN Demo | ||
|
||
|
||
Setup | ||
##### | ||
|
||
.. include:: /includes/install_from_pypi.rst | ||
|
||
Pipeline | ||
######## | ||
|
||
.. image:: /_static/images/pipelines/camera_control_with_NN.png | ||
:alt: Pipeline graph | ||
|
||
|
||
Source Code | ||
########### | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Python | ||
|
||
Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/camera_control_with_NN.py>`__ | ||
|
||
.. literalinclude:: ../../../../examples/CameraComponent/camera_control_with_NN.py | ||
:language: python | ||
:linenos: | ||
|
||
.. include:: /includes/footer-short.rst |
43 changes: 43 additions & 0 deletions
43
depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_preview.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
Camera Preview | ||
============== | ||
|
||
This example shows how to set up a pipeline that outputs a a preview for color camera, both mono cameras and their stereo depth. Each frame is displayed using OpenCV in blocking behavour. | ||
|
||
.. include:: /includes/blocking_behavior.rst | ||
|
||
|
||
|
||
Demo | ||
#### | ||
|
||
.. image:: /_static/images/demos/sdk_camera_preview.png | ||
:alt: Camera Preview Demo | ||
|
||
|
||
Setup | ||
##### | ||
|
||
.. include:: /includes/install_from_pypi.rst | ||
|
||
Pipeline | ||
######## | ||
|
||
.. image:: /_static/images/pipelines/camera_preview.png | ||
:alt: Pipeline graph | ||
|
||
|
||
|
||
Source Code | ||
########### | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Python | ||
|
||
Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/camera_preview.py>`__ | ||
|
||
.. literalinclude:: ../../../../examples/CameraComponent/camera_preview.py | ||
:language: python | ||
:linenos: | ||
|
||
.. include:: /includes/footer-short.rst |
40 changes: 40 additions & 0 deletions
40
depthai_sdk/docs/source/samples/CameraComponent/sdk_mono_400p.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
Mono Camera Preview | ||
=================== | ||
|
||
This example shows how to set up a pipeline that outputs a video feed for both mono cameras and sets the resolution to 400p (640x400) and the frame rate to 60 fps. | ||
|
||
.. include:: /includes/blocking_behavior.rst | ||
|
||
Demo | ||
#### | ||
|
||
.. image:: /_static/images/demos/sdk_mono_400p.png | ||
:alt: Mono Demo | ||
|
||
|
||
Setup | ||
##### | ||
|
||
.. include:: /includes/install_from_pypi.rst | ||
|
||
Pipeline | ||
######## | ||
|
||
.. image:: /_static/images/pipelines/mono_400p.png | ||
:alt: Pipeline graph | ||
|
||
|
||
Source Code | ||
########### | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Python | ||
|
||
Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/mono_400p.py>`__ | ||
|
||
.. literalinclude:: ../../../../examples/CameraComponent/mono_400p.py | ||
:language: python | ||
:linenos: | ||
|
||
.. include:: /includes/footer-short.rst |
41 changes: 41 additions & 0 deletions
41
depthai_sdk/docs/source/samples/CameraComponent/sdk_preview_all_cameras.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Preview All Cameras | ||
=================== | ||
|
||
This example shows how to set up a pipeline that outputs a a preview for each camera currently connected (and available) to the device. The preview is displayed in a window on the host machine. | ||
If run on OAK-D devices, this example does the same thing as the ``sdk_camera_preview`` example. | ||
|
||
.. include:: /includes/blocking_behavior.rst | ||
|
||
Demo | ||
#### | ||
|
||
.. image:: /_static/images/demos/sdk_preview_all_cameras.png | ||
:alt: Camera Preview Demo | ||
|
||
|
||
Setup | ||
##### | ||
|
||
.. include:: /includes/install_from_pypi.rst | ||
|
||
Pipeline | ||
######## | ||
|
||
.. image:: /_static/images/pipelines/preview_all_cameras.png | ||
:alt: Pipeline graph | ||
|
||
|
||
Source Code | ||
########### | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Python | ||
|
||
Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/preview_all_cameras.py>`__ | ||
|
||
.. literalinclude:: ../../../../examples/CameraComponent/preview_all_cameras.py | ||
:language: python | ||
:linenos: | ||
|
||
.. include:: /includes/footer-short.rst |
Oops, something went wrong.