此页面由 AI 自动翻译。查看英文原版
Claude CodeCodexCursor
Luxonis 智能体工具包为你常用的编程智能体加载 Luxonis 上下文与技能,更快地基于 OAK 开发应用。
安装工具包

Cookie-cutter 模板应用程序

开始使用 Luxonis 生态系统最快的方法是使用模板应用程序。此应用程序是您自己应用程序的起点,包含所有必要的组件,可帮助您快速启动和运行。应用程序范围从非常简单的管道(例如摄像头流)到复杂且全面的管道(例如使用自定义 AI 模型和节点)。
在 5 分钟内启动并运行:
Command Line
1# 安装核心包
2pip install depthai --force-reinstall
3# 克隆模板应用
4git clone https://github.com/luxonis/oak-template.git
5# 切换到模板应用目录
6cd oak-template
7# 安装依赖
8pip install -r requirements.txt
这会将模板/cookie-cutter 应用程序下载到您当前的目录。
Text
1template-app/
2├── main.py
3├── oakapp.toml
4├── requirements.txt
5├── media/ # 可选媒体文件
6└── utils/ # 可选辅助函数
这是您的主要逻辑所在。下载的脚本将使用“Camera + NN + Hub”作为默认管道。如果您不需要 NN 或 Hub 功能,可以随意将其替换为以下任何其他示例。
Python
1import depthai as dai
2import os
3
4from depthai_nodes.node import SnapsUploader
5from depthai_nodes.node.parsing_neural_network import ParsingNeuralNetwork
6from utils.snaps_producer import SnapsProducer
7from dotenv import load_dotenv
8
9# 假设 `DEPTHAI_HUB_API_KEY` 在工作区根目录的 `.env` 文件中定义。
10# 在初始化管道之前加载环境变量。
11load_dotenv(override=True)
12
13model = "luxonis/yolov6-nano:r2-coco-512x288"
14time_interval = 10.0  # 快照上传之间的最小秒数
15
16visualizer = dai.RemoteConnection(httpPort=8082)
17device = dai.Device()
18
19with dai.Pipeline(device) as pipeline:
20    print("正在创建管道...")
21
22    model_description = dai.NNModelDescription(model)
23    platform = device.getPlatformAsString()
24    model_description.platform = platform
25    nn_archive = dai.NNArchive(
26        dai.getModelFromZoo(
27            model_description,
28        )
29    )
30
31    input_node = pipeline.create(dai.node.Camera).build()
32
33    nn_with_parser = pipeline.create(ParsingNeuralNetwork).build(
34        input_node, nn_archive
35    )
36
37    visualizer.addTopic("Video", nn_with_parser.passthrough, "images")
38    visualizer.addTopic("Visualizations", nn_with_parser.out, "images")
39
40    snaps_producer = pipeline.create(SnapsProducer).build(
41        frame=nn_with_parser.passthrough,
42        detections=nn_with_parser.out,
43        time_interval=time_interval
44    )
45
46    snaps_uploader = pipeline.create(SnapsUploader).build(snaps_producer.out)
47
48    print("管道已创建。")
49
50    pipeline.start()
51    visualizer.registerPipeline(pipeline)
52
53    while pipeline.isRunning():
54        key = visualizer.waitKey(1)
55        if key == ord("q"):
56            print("从远程连接收到 q 键!")
57            break

DepthAI 示例

如果您希望使用不同的管道,可以在此处找到可用节点及其示例列表

您可以在此处定义容器的构建过程。对于模板应用程序,我们建议使用 Luxonis 基础镜像并从 requirements.txt 安装 Python 依赖项。您可以在 此处找到更多信息。
Toml
1identifier = "custom.oakapp"
2app_version = "1.0.0"
3
4prepare_container = [
5    { type = "RUN", command = "apt-get update" },
6    { type = "RUN", command = "apt-get install -y python3 python3-pip wget git" },
7]
8
9prepare_build_container = []
10
11build_steps = ["pip3 install -r /app/requirements.txt --break-system-packages"]
12
13entrypoint = ["bash", "-c", "python3 /app/main.py"]
14
15[base_image]
16api_url = "https://registry-1.docker.io"
17service = "registry.docker.io"
18oauth_url = "https://auth.docker.io/token"
19auth_type = "repository"
20auth_name = "luxonis/oakapp-base"
21image_name = "luxonis/oakapp-base"
22image_tag = "1.2.6"
如果您正在使用 Luxonis Hub,就像“Camera + NN + HUB (默认)”示例中那样,您将需要使用 Hub API 密钥进行身份验证。最简单的安全方法是在应用程序的根文件夹中创建一个 .env 文件并插入:
Command Line
1# .env 文件的内容
2DEPTHAI_HUB_API_KEY=<在此处插入您的 HUB API 密钥>
要获取 API 密钥,您首先需要创建一个 Luxonis Hub 帐户,然后导航到团队设置并单击“创建 API 密钥”按钮。这是安全的,因为 .env 文件会自动被 git 忽略,因此没有将您的私有 API 密钥上传到公共仓库的危险,每个人都可以看到它。.env 文件中的变量由 dotenv 库设置,然后使用存储在 DEPTHAI_HUB_API_KEY 环境变量中的密钥自动完成身份验证。请查看我们的API 密钥安全 - 最佳实践页面,了解安全地将 API 密钥传递给应用程序的其他示例。
现在您已经有了 main.py 和 oakapp.toml,您可以通过以下方式之一部署您的应用程序:

独立

这是最简单的选项。只需在与 main.py 和 oakapp.toml 文件相同的目录中运行以下命令:
Command Line
1oakctl app run .
此命令将您的应用程序构建到容器中,并直接在 OAK 设备上运行,无需主机端应用程序进程。结果可以通过可视化器 Web 应用程序在 http://<device-ip>:8082 查看。

外设

此选项适用于您希望从主机运行应用程序的情况。在此模式下不需要容器化,但您需要与设备建立稳定的连接。要在外设模式下运行应用程序,请运行以下命令:
Command Line
1python3 main.py
结果可以通过可视化器 Web 应用程序在 http://<host-ip>:8082 查看。

继续开发

按照 OAK 应用程序部分的教程和指南继续开发您的应用程序。
打开 OAK 应用程序概述

将应用程序发布到 Luxonis Hub

构建并发布应用程序,以便您的团队可以从 Hub 安装它。
转到应用程序发布