Merge pull request #1012 from luxonis/develop

DepthAI SDK 1.10.0

Author: daniilpastukhov

depthai_sdk/MANIFEST.in

@@ -1,6 +1,7 @@
 include src/depthai_sdk/classes/*.py
 recursive-include src/depthai_sdk/components *.py
 recursive-include src/depthai_sdk/integrations *.py
+recursive-include src/depthai_sdk/trigger_action *.py
 include src/depthai_sdk/managers/*.py
 
 recursive-include src/depthai_sdk/nn_models handler.py

depthai_sdk/docs/source/features/conditional-actions.rst

@@ -0,0 +1,75 @@
+Conditional actions
+===================
+
+DepthAI SDK provides a way to perform actions based on some conditions.
+For example, you can perform an action when a certain number of objects is detected in the frame.
+This functionality can be achieved by using Trigger-Action API.
+
+Overview
+--------
+Trigger-Action API is a way to define a set of conditions and actions that should be performed when these conditions are met.
+DepthAI SDK provides a set of predefined conditions and actions, but you can also define your own.
+
+Basic concepts:
+
+- **Trigger** - a condition that should be met to perform an action.
+- **Action** - an action that should be performed when a trigger is met.
+
+.. note:: Trigger-Action API is implemented in the :mod:`depthai.trigger_action` module.
+
+Triggers
+--------
+
+The base class for all triggers is :class:`Trigger <depthai_sdk.trigger_action.Trigger>`.
+In order to create a trigger, you need to use the :class:`Trigger <depthai_sdk.trigger_action.Trigger>` class and pass the following parameters:
+
+- ``input`` - a component that should be used as a trigger source.
+- ``condition`` - a function that should return ``True`` or ``False`` based on the trigger source.
+- ``cooldown`` - defines how often a trigger can be activated (in seconds).
+
+The set of predefined triggers:
+
+- :class:`DetectionTrigger <depthai_sdk.trigger_action.DetectionTrigger>` - a trigger that is activated when a certain number of objects is detected in the frame.
+
+Actions
+-------
+
+An action can be represented by either a function or a class derived from :class:`Action <depthai_sdk.trigger_action.Action>` class.
+The custom action should implement :meth:`activate() <depthai_sdk.trigger_action.Action.activate>` and optionally :meth:`on_new_packets() <depthai_sdk.trigger_action.Action.on_new_packets>` methods.
+
+The set of predefined actions:
+
+- :class:`RecordAction <depthai_sdk.trigger_action.RecordAction>` - records a video of a given duration when a trigger is activated.
+
+Usage
+-----
+
+The following example shows how to create a trigger that is activated when at least 1 person is detected in the frame.
+When the trigger is activated, it records a 15 seconds video (5 seconds before the trigger is activated and 10 seconds after).
+
+.. literalinclude:: ../../../examples/trigger_action/person_record.py
+   :language: python
+
+Reference
+-------------
+
+.. autoclass:: depthai_sdk.trigger_action.TriggerAction
+    :members:
+    :undoc-members:
+
+.. autoclass:: depthai_sdk.trigger_action.Trigger
+    :members:
+    :undoc-members:
+
+.. autoclass:: depthai_sdk.trigger_action.Action
+    :members:
+    :undoc-members:
+
+.. autoclass:: depthai_sdk.trigger_action.DetectionTrigger
+    :members:
+    :undoc-members:
+
+.. autoclass:: depthai_sdk.trigger_action.RecordAction
+    :members:
+    :undoc-members:
+

depthai_sdk/docs/source/includes/footer-short.rst

@@ -1,28 +1,5 @@
 .. raw:: html
 
-    <h2>Got questions?</h2>
+   <h2>Got questions?</h2>
 
-We're always happy to help with development or other questions you might have.
-
-.. raw:: html
-
-     <div class="cta-row cta-row-short">
-         <div class="cta-box">
-            <a href="https://luxonis.com/discord">
-               <img src="/_images/discord.png" alt="Discord"/>
-               <h5 class="cta-title">Community Discord</h5>
-            </a>
-         </div>
-         <div class="cta-box">
-            <a href="https://discuss.luxonis.com/">
-               <img src="/_images/forum.png" alt="forum"/>
-               <h5 class="cta-title">Discussion Forum</h5>
-            </a>
-         </div>
-         <div class="cta-box">
-            <a href="mailto:support@luxonis.com">
-               <img src="/_images/email.png" alt="forum"/>
-               <h5 class="cta-title">Email</h5>
-            </a>
-         </div>
-      </div>
+   Head over to <a href="https://discuss.luxonis.com/"><strong>Discussion Forum</strong></a> for technical support or any other questions you might have.

depthai_sdk/examples/CameraComponent/camera_control.py

@@ -0,0 +1,21 @@
+from depthai_sdk import OakCamera
+
+with OakCamera() as oak:
+    color = oak.create_camera('color')
+    oak.visualize(color, fps=True, scale=2/3)
+    oak.start()
+
+    while oak.running():
+        key = oak.poll()
+        if key == ord('i'):
+            color.control.exposure_time_down()
+        elif key == ord('o'):
+            color.control.exposure_time_up()
+        elif key == ord('k'):
+            color.control.sensitivity_down()
+        elif key == ord('l'):
+            color.control.sensitivity_up()
+
+        elif key == ord('e'): # Switch to auto exposure
+            color.control.send_controls({'exposure': {'auto': True}})
+

depthai_sdk/examples/NNComponent/object_tracking.py

@@ -7,6 +7,7 @@
     # https://docs.luxonis.com/projects/sdk/en/latest/features/ai_models/#sdk-supported-models
     nn = oak.create_nn('yolov6nr3_coco_640x352', color, tracker=True)
 
+    nn.config_nn(resize_mode='stretch')
     nn.config_tracker(
         tracker_type=dai.TrackerType.ZERO_TERM_COLOR_HISTOGRAM,
         track_labels=[0], # Track only 1st object from the object map. If unspecified, track all object types

depthai_sdk/examples/StereoComponent/stereo_control.py

@@ -0,0 +1,27 @@
+from depthai_sdk import OakCamera
+
+with OakCamera() as oak:
+    left = oak.create_camera('left')
+    right = oak.create_camera('right')
+    stereo = oak.create_stereo(left=left, right=right)
+    stereo.config_stereo(lr_check=True)
+
+    oak.visualize([right, stereo.out.disparity], fps=True)
+    oak.start()
+
+    while oak.running():
+        key = oak.poll()
+
+        if key == ord('i'):
+            stereo.control.confidence_threshold_down()
+        if key == ord('o'):
+            stereo.control.confidence_threshold_up()
+        if key == ord('k'):
+            stereo.control.switch_median_filter()
+
+        if key == ord('1'):
+            stereo.control.send_controls({'postprocessing': {'decimation': {'factor': 1}}})
+        if key == ord('2'):
+            stereo.control.send_controls({'postprocessing': {'decimation': {'factor': 2}}})
+        if key == ord('3'):
+            stereo.control.send_controls({'postprocessing': {'decimation': {'factor': 3}}})

depthai_sdk/examples/mixed/car_tracking.py

@@ -4,9 +4,10 @@
 with OakCamera(replay='cars-tracking-above-01') as oak:
     # Create color camera, add video encoder
     color = oak.create_camera('color')
+
     # Download & run pretrained vehicle detection model and track detections
     nn = oak.create_nn('vehicle-detection-0202', color, tracker=True)
-    nn.config_nn(resize_mode=ResizeMode.STRETCH)
+
     # Visualize tracklets, show FPS
     visualizer = oak.visualize(nn.out.tracker, fps=True, record_path='./car_tracking.avi')
     visualizer.tracking(line_thickness=5).text(auto_scale=True)

depthai_sdk/examples/mixed/speed_calculation.py

@@ -17,7 +17,6 @@ def callback(packet):
     stereo.config_stereo(subpixel=False, lr_check=True)
 
     nn = oak.create_nn('face-detection-retail-0004', color, spatial=stereo, tracker=True)
-    nn.config_nn(resize_mode='stretch')
 
     visualizer = oak.visualize(nn.out.tracker, callback=callback, fps=True)
     visualizer.tracking(speed=True).text(auto_scale=True)

depthai_sdk/examples/mixed/switch_between_models.py

@@ -26,7 +26,7 @@ def cb(packet: DetectionPacket):
             if len(outputs) <= i:
                 i = 0
 
-        node.io[outputs[i]].send(frame)    
+        node.io[outputs[i]].send(frame)
     """)
     color.stream.link(script.inputs['frames'])
 
@@ -39,6 +39,7 @@ def cb(packet: DetectionPacket):
     xin.out.link(script.inputs['switch'])
 
     oak.visualize([nn1, nn2], fps=True, callback=cb)
+    oak.visualize([nn1.out.passthrough, nn2.out.passthrough], fps=True)
 
     # oak.show_graph()
 

depthai_sdk/examples/recording/stereo_record.py

@@ -21,6 +21,6 @@
     # oak.record([color.out.main, stereo.out.disparity], 'records')
 
     # Record depth only
-    oak.visualize(stereo.out.disparity, record_path='disparity.avi')
+    oak.visualize(stereo.out.disparity, record_path='disparity.mp4')
 
     oak.start(blocking=True)