此页面由 AI 自动翻译。查看英文原版
最后更新

本页目录

  • 什么是 OAK Apps?
  • 创建您的 OAK App
  • 使用 oakctl 部署
  • 操作系统兼容性图表
  • 构建和运行应用程序
  • 应用程序管理
  • 设备管理
  • oakapp.toml 配置
Claude CodeCodexCursor
Luxonis 智能体工具包为你常用的编程智能体加载 Luxonis 上下文与技能,更快地基于 OAK 开发应用。
安装工具包

OAK Apps 概述

最后更新
OAK Apps 允许您在 Luxonis OAK 设备(从单个单元到设备群)上开发、容器化、部署和管理容器化视觉应用程序。它们运行在 OAK4 设备上预装的 oak-agent 服务(Luxonis OS 的一部分)上,因此您可以立即开始部署。

什么是 OAK Apps?

OAK Apps 是基于 DepthAI 框架构建的容器化计算机视觉应用程序,直接在 OAK 设备上运行。它们提供:
  • 一致的开发环境 - 一次构建,随处部署
  • 简化的部署 - 打包应用程序所需的一切
  • 设备群管理 - 同时部署到多个设备
  • 与 Luxonis Hub 集成 - 远程监控和管理设备
值得一提的是,一旦应用程序构建完成(即生成 .oakapp 文件),您就可以将其移动并安装到其他设备上,而无需重新构建或需要互联网连接。

默认应用程序演示

查看预构建的默认应用程序,预览完成的 OAK App 可能是什么样子。
在 GitHub 上查看
默认应用程序演示

创建您的 OAK App

项目结构

一个基本的 OAK App 项目结构:
Text
1my-oak-app/
2├── .oakappignore      # (可选) 在设备上构建应用程序时要忽略的文件
3├── main.py            # 您的主要应用程序代码
4├── requirements.txt   # Python 依赖项
5└── oakapp.toml        # 应用程序配置
oakapp.toml 文件是必需的,包含应用程序元数据和构建说明。

应用程序开发

创建 OAK App 从 DepthAI API 开始,它是驱动所有 OAK 设备功能的核心框架:
Command Line
1# 安装 DepthAI SDK
2pip install depthai --force-reinstall
3
4# 使用 DepthAI 的 Python API 创建您的应用程序
5# - 访问摄像头流
6# - 运行神经网络推理
7# - 处理深度数据
8# - 利用边缘处理能力

使用 oakctl 部署

oakctl 是一个命令行工具,允许您与 OAK4 摄像头进行交互。它可用于在运行 oak-agent 服务的设备上创建、部署和管理应用程序。

Linux/MacOS

在 64 位系统上,运行:
Command Line
1bash -c "$(curl -fsSL https://oakctl-releases.luxonis.com/oakctl-installer.sh)"

Windows

使用 Windows 安装程序 下载并安装。

操作系统兼容性图表

RVC4 操作系统版本 oakctl 版本 命令
OS 1.14.1+ 0.11.0+ oakctl self-update (当前稳定版)
OS 1.110.9.0 oakctl self-update -v 0.9.0
OS 1.80.4.2oakctl self-update -v 0.4.2
OS 1.60.2.11oakctl self-update -v 0.2.11

构建和运行应用程序

使用 oakctl 构建和运行 OAK Apps 非常简单:
Command Line
1# 直接从源代码运行应用程序
2oakctl app run ./my-oak-app
3
4# 将应用程序构建为可分发包
5oakctl app build ./my-oak-app
6
7# 安装已构建的应用程序
8oakctl app install my-oak-app.oakapp

应用程序管理

您可以使用以下命令管理应用程序:
Command Line
1# 列出已安装的应用程序
2oakctl app list
3
4# 启动应用程序
5oakctl app start <container-id>
6
7# 查看应用程序日志
8oakctl app logs <container-id>
9
10# 停止应用程序
11oakctl app stop <container-id>
12
13# 启用自动启动
14oakctl app enable <container-id>

设备管理

Command Line
1# 列出连接的设备
2oakctl list
3
4# 连接到特定设备
5oakctl connect <device-ip>

oakapp.toml 配置

oakapp.toml 文件定义了应用程序的构建和运行时配置:
Toml
1# (Required) App Identifier
2identifier = "com.luxonis.python_demo"
3# (Required) App Entrypoint
4entrypoint = ["bash", "-c", "python3 /app/main.py"]
5
6# (Optional) Prepare container commands
7# Here is the place where you can install all the dependencies that are needed at run-time
8prepare_container = [
9    { type = "COPY", source = "requirements.txt", target = "requirements.txt" },
10    { type = "RUN", command = "apt-get update" },
11    { type = "RUN", command = "apt-get install -y python3-pip" },
12    { type = "RUN", command = "pip3 install -r /app/requirements.txt --break-system-packages" },
13]
14
15# (Optional) Prepare build dependencies
16# Here is the place where you can install all the dependencies that are needed at build-time
17prepare_build_container = [
18    # Example: npm, gcc, ...
19]
20
21# (Optional) Additional commands after all the app files are copied to the container
22build_steps = []
有关所有可用配置选项,请参阅完整参考。