Skip to content

Commit e738ead

Browse files
authored
Docs update (#1000)
* Update sync_node.rst * Adding USB 3.2Gen2 enable docs
1 parent 777d3a2 commit e738ead

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

docs/source/components/nodes/sync_node.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,36 @@ Message Synchronization
4747
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>`.
4848

4949

50+
51+
.. code-block::
52+
53+
┌──────────────────────┐
54+
│ Get all messages │
55+
│ connected to the │
56+
│ Sync node │
57+
└──────────────────────┘
58+
|
59+
v
60+
┌──────────────────────┐
61+
│ Check if messages │
62+
│ are synced (min and │
63+
│ max timestamp diff │<----------------+
64+
│ < threshold) │ |
65+
└──────────────────────┘ |
66+
| |
67+
┌────────────────────┐ | ┌──────────────────────┐
68+
│ Combine into │ if synced | if not synced │ Get message with │
69+
│ MessageGroup │<-----------------+----------------->│ the oldest timestamp │
70+
└────────────────────┘ └──────────────────────┘
71+
|
72+
v
73+
┌───────────────┐
74+
│ Out │
75+
└───────────────┘
76+
77+
78+
79+
5080
Usage
5181
#####
5282

docs/source/tutorials/low-latency.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ Low Latency
44
These tables show what performance you can expect from **USB 3.2** Gen 1 (5 Gbps) connection with an OAK camera. XLink chunking was
55
disabled for these tests (:code:`pipeline.setXLinkChunkSize(0)`). For an example code, see :ref:`Latency measurement`.
66

7+
.. note::
8+
9+
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:
10+
11+
.. code-block:: python
12+
13+
with dai.Device(pipeline, maxUsbSpeed=dai.UsbSpeed.SUPER_PLUS) as device:
14+
15+
716
.. list-table:: USB 5gbps latency
817
:header-rows: 1
918

0 commit comments

Comments
 (0)