最后更新
设备 API
Device 对象代表一个 OAK 设备。启动设备时,您必须将一个 Pipeline 上传到设备,该 Pipeline 将在 VPU 上执行。 当您在代码中创建设备时,固件会与 Pipeline 和其他资产(例如 NN blob)一起上传。Python
1pipeline = depthai.Pipeline()
2
3# 创建节点,配置它们并将它们链接在一起
4
5# 连接到设备并将 Pipeline 上传到设备
6with depthai.Device(pipeline) as device:
7 # 打印 MxID、USB 速度和设备上可用的摄像头
8 print('MxId:',device.getDeviceInfo().getMxId())
9 print('USB speed:',device.getUsbSpeed())
10 print('Connected cameras:',device.getConnectedCameras())连接到指定设备
Python
1# 指定 MXID、IP 地址或 USB 路径
2device_info = depthai.DeviceInfo("14442C108144F1D000") # MXID
3#device_info = depthai.DeviceInfo("192.168.1.44") # IP 地址
4#device_info = depthai.DeviceInfo("3.3.3") # USB 端口名称
5with depthai.Device(pipeline, device_info) as device:
6 # ...时钟
dai.Clock.now() (Python) 或 dai::Clock::now() (C++) 是一个单调时钟,用于 depthai 库中的时间戳。它派生自 std::chrono::steady_clock,不受系统时间更改(例如 NTP 同步)的影响。该方法返回自主机(PC)启动以来的 datetime.timedelta (Python) 或 std::chrono::steady_clock::duration (C++)。它用于在设备 消息 上调用 getTimestamp() 时,并将指示消息在设备上创建的时间。设备上还有一个单独的单调时钟,用于检索自设备 (OAK) 启动以来的时间,可以使用 getTimestampDevice() 调用。主机时钟同步



Python
1# 配置主机时钟同步示例
2
3import depthai as dai
4from datetime import timedelta
5# 配置 Pipeline
6with dai.Device(pipeline) as device:
7 # 第一个值:时间同步运行之间的间隔
8 # 第二个值:每次运行的时间同步样本数,用于计算更好的值
9 # 第三个值:如果为 true,则部分时间同步请求将以随机间隔执行,否则以固定间隔执行
10 device.setTimesync(timedelta(seconds=5), 10, True) # (这些是默认值)设备队列

Py
1pipeline = dai.Pipeline()
2
3xout = pipeline.createXLinkOut()
4xout.setStreamName("output_name")
5# ...
6xin = pipeline.createXLinkIn()
7xin.setStreamName("input_name")
8# ...
9with dai.Device(pipeline) as device:
10
11 outputQueue = device.getOutputQueue("output_name", maxSize=5, blocking=False)
12 inputQueue = device.getInputQueue("input_name")
13
14 outputQueue.get() # 从队列中读取,阻塞直到消息到达
15 outputQueue.tryGet() # 从队列中读取,如果没有消息则返回 None(不阻塞)
16 if outputQueue.has(): # 检查队列中是否有任何消息输出队列设置
while True 循环中),队列,无论其大小如何,大部分时间都将保持为空。但是,随着我们在主机端添加内容(额外的处理、分析等),设备可能会比主机读取速度更快地将消息推送到主机队列。然后队列中的消息将开始增加——在这种情况下,maxSize 和 blocking 设置将决定队列的行为。两种常见的配置是:Py
1with dai.Device(pipeline) as device:
2 # 如果您只想要最新消息,并且不关心以前的消息;
3 # 当新消息到达主机时,如果它仍在队列中,它将覆盖以前(最旧的)消息
4 q1 = device.getOutputQueue(name="name1", maxSize=1, blocking=False)
5
6
7 # 如果您关心每一条消息(例如 H264/5 编码视频;如果您错过一帧,您将得到伪影);
8 # 如果队列已满,设备将等待主机从队列中读取消息
9 q2 = device.getOutputQueue(name="name2", maxSize=30, blocking=True) # 也是默认值 (maxSize=30/blocking=True)maxSize=30 只是一个例子,它可以是任何 int16 数字。由于设备队列在主机计算机上,内存 (RAM) 通常不是那么稀缺,因此 maxSize 不会那么重要。 但是,如果您使用像 RPI Zero (512MB RAM) 这样的小型 SBC,并且正在流式传输大帧(例如 4K 未编码),如果您将 maxSize 设置为高值(并且没有足够快地从队列中读取),您可能会很快耗尽内存。一些额外信息
- 队列是线程安全的——它们可以从任何线程访问。
- 队列的创建方式是每个队列都有自己的线程,负责接收、序列化/反序列化和转发消息(输入/输出队列相同)。
Device对象不是完全线程安全的。一些 RPC 调用(例如getLogLevel、setLogLevel、getDdrMemoryUsage)一旦设置了互斥锁就会变得线程安全(目前可能存在竞争)。
看门狗
自定义看门狗超时
DEPTHAI_WATCHDOG_INITIAL_DELAY 和 DEPTHAI_BOOTUP_TIMEOUT 设置为您所需的超时值(以毫秒为单位),如下所示:Linux/macOS
Command Line
1DEPTHAI_WATCHDOG_INITIAL_DELAY=<my_value> DEPTHAI_BOOTUP_TIMEOUT=<my_value> python3 script.pyPython
1pipeline = depthai.Pipeline()
2
3# 创建一个 BoardConfig 对象
4config = depthai.BoardConfig()
5
6# 设置参数
7config.watchdogInitialDelayMs = <my_value>
8config.watchdogTimeoutMs = <my_value>
9
10pipeline.setBoardConfig(config)环境变量
| 环境变量 | 说明 |
|---|---|
DEPTHAI_LEVEL | 设置日志记录详细程度,选项:'trace'、'debug'、'warn'、'error'、'off' |
XLINK_LEVEL | 设置 XLink 库的日志记录详细程度,选项:'debug'、'info'、'warn'、'error'、'fatal'、'off' |
DEPTHAI_INSTALL_SIGNAL_HANDLER | 设置为 0 可禁用安装 Backward 信号处理程序以进行堆栈跟踪打印 |
DEPTHAI_WATCHDOG | 设置设备看门狗超时。用于调试(DEPTHAI_WATCHDOG=0),以防止进程暂停时设备重置。 |
DEPTHAI_WATCHDOG_INITIAL_DELAY | 指定设备看门狗启动后的延迟。 |
DEPTHAI_SEARCH_TIMEOUT | 指定阻塞函数中设备搜索的超时时间(以毫秒为单位)。 |
DEPTHAI_CONNECT_TIMEOUT | 指定建立与给定设备连接的超时时间(以毫秒为单位)。 |
DEPTHAI_BOOTUP_TIMEOUT | 指定发送二进制文件后等待设备启动的超时时间(以毫秒为单位)。 |
DEPTHAI_PROTOCOL | 将默认搜索限制为指定的协议。选项:any、usb、tcpip。 |
DEPTHAI_DEVICE_MXID_LIST | 将默认搜索限制为指定的 MXID。接受逗号分隔的 MXID 列表。列表以“AND”方式而不是“OR”方式过滤结果 |
DEPTHAI_DEVICE_ID_LIST | MXID 列表的别名。列表以“AND”方式而不是“OR”方式过滤结果 |
DEPTHAI_DEVICE_NAME_LIST | 将默认搜索限制为指定的 NAME。接受逗号分隔的 NAME 列表。列表以“AND”方式而不是“OR”方式过滤结果 |
DEPTHAI_DEVICE_BINARY | 覆盖设备固件二进制文件。主要用于内部调试。 |
DEPTHAI_BOOTLOADER_BINARY_USB | 覆盖设备 USB 引导加载程序二进制文件。主要用于内部调试。 |
DEPTHAI_BOOTLOADER_BINARY_ETH | 覆盖设备网络引导加载程序二进制文件。主要用于内部调试。 |
DEPTHAI_DISABLE_CRASHDUMP_COLLECTION | 设置为 1 时,禁用向 Luxonis 发送崩溃转储。默认情况下,崩溃转储、管道、操作系统和 depthai 版本信息会发送给 Luxonis 以进行诊断。 |
DEPTHAI_ENABLE_ANALYTICS_COLLECTION | 设置为 1 时,分析数据(管道架构)会发送给 Luxonis,用于进一步改进库。 |
参考
class
depthai.Device(depthai.DeviceBase)
class
Config
Device specific configuration
method
method
method
method
getInputQueueNames(self) -> list[str]: list[str]Get all available input queue names Returns: Vector of input queue names
method
method
getOutputQueueNames(self) -> list[str]: list[str]Get all available output queue names Returns: Vector of output queue names
method
method
class
depthai.Device.Config
variable
variable
variable
variable
variable
method