Skip to content

Commit

Permalink
Docs update (#1000)
Browse files Browse the repository at this point in the history
* Update sync_node.rst
* Adding USB 3.2Gen2 enable docs
  • Loading branch information
jakaskerl authored Mar 29, 2024
1 parent 777d3a2 commit e738ead
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/source/components/nodes/sync_node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,36 @@ Message Synchronization
The Sync node aligns incoming messages based on their timestamps. The synchronization criteria and behavior can be configured using the :code:`depthai.node.Sync.setSyncThreshold` and :code:`depthai.node.Sync.setSyncAttempts` method. More info in the :ref:`API Reference <reference>`.



.. code-block::
┌──────────────────────┐
│ Get all messages │
│ connected to the │
│ Sync node │
└──────────────────────┘
|
v
┌──────────────────────┐
│ Check if messages │
│ are synced (min and │
│ max timestamp diff │<----------------+
│ < threshold) │ |
└──────────────────────┘ |
| |
┌────────────────────┐ | ┌──────────────────────┐
│ Combine into │ if synced | if not synced │ Get message with │
│ MessageGroup │<-----------------+----------------->│ the oldest timestamp │
└────────────────────┘ └──────────────────────┘
|
v
┌───────────────┐
│ Out │
└───────────────┘
Usage
#####

Expand Down
9 changes: 9 additions & 0 deletions docs/source/tutorials/low-latency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ Low Latency
These tables show what performance you can expect from **USB 3.2** Gen 1 (5 Gbps) connection with an OAK camera. XLink chunking was
disabled for these tests (:code:`pipeline.setXLinkChunkSize(0)`). For an example code, see :ref:`Latency measurement`.

.. note::

To enable 10Gbps USB3 mode (when using a **USB 3.2 Gen 2** compliant cable), you has to explicitly set it in :code:`Device` constructor:

.. code-block:: python
with dai.Device(pipeline, maxUsbSpeed=dai.UsbSpeed.SUPER_PLUS) as device:
.. list-table:: USB 5gbps latency
:header-rows: 1

Expand Down

0 comments on commit e738ead

Please sign in to comment.