# 软件

使用以下链接跳过逐步介绍，直接进入 Luxonis SDK 和完整的 OAK 软件栈：DepthAI API、工具和示例，适用于 OAK USB、PoE 和 OAK4 相机。

### DepthAI API（Python/C++）

用于在 OAK 和 OAK4 相机上构建流水线和应用的 DepthAI v3 SDK 库。

[打开 DepthAI API 文档](https://docs.luxonis.com/software-v3/depthai.md)

### oakctl CLI

用于管理和配置 OAK4 设备以及部署应用的命令行工具。

[安装 oakctl](https://docs.luxonis.com/software-v3/oak-apps/oakctl.md)

### DepthAI 示例

用于在 OAK 相机上构建 DepthAI 流水线的参考示例。

[浏览示例](https://docs.luxonis.com/software-v3/depthai/examples.md)

如需轻松逐步入门 OAK4 和 OAK 设备，请按照以下步骤操作。

### 开始入门

为您的设备选择正确的入门指南。

### 连接 OAK4

使用基于 RVC4 的 OAK4 入门指南来设置硬件并执行初始配置。

[OAK4 入门指南](https://docs.luxonis.com/hardware/platform/deploy/oak4-deployment-guide/oak4-getting-started.md)

### 连接 OAK

按照基于 RVC2 的 OAK 入门指南了解如何将其连接到主机 PC。

[OAK 入门指南](https://docs.luxonis.com/hardware/platform/deploy/usb-deployment-guide.md)

连接好相机后，最快的入门方式是运行 OAK Viewer。

### OAK Viewer

OAK Viewer 是一款桌面 GUI 应用，可让您可视化相机流并与设备交互。它适用于 Windows、macOS 和 Linux。

警告： 在 OAK Viewer 中，您只能测试 Viewer 中包含的选定 Luxonis 模型库模型。您无法上传自定义模型或使用其他库模型。如需上传和验证自定义模型，请参阅 [在 HubAI
上使用自定义模型](https://docs.luxonis.com/cloud/tutorials/use-custom-models-on-hub-ai.md) 教程。

[点击此处开始](https://docs.luxonis.com/software-v3/depthai/tools/oak-viewer.md)

### 运行您的第一个应用

尝试我们提供的 [预构建应用](https://github.com/luxonis/oak-examples/tree/main)，初步体验我们的生态系统。以下是如何启动通用神经网络应用的示例：

### 在 OAK4 上运行第一个应用

### 安装 oakctl

#### Linux/MacOS

在 64 位系统上，运行：

```bash
bash -c "$(curl -fsSL https://oakctl-releases.luxonis.com/oakctl-installer.sh)"
```

#### Windows

下载并使用 [Windows 安装程序](https://oakctl-releases.luxonis.com/data/latest/windows_x86_64/oakctl.msi) 进行安装。

### 部署示例应用

```bash
# 连接到设备
oakctl connect
# 克隆仓库
git clone --depth 1 --branch main https://github.com/luxonis/oak-examples.git
# 切换到通用示例目录
cd oak-examples/neural-networks/generic-example/
# 运行应用并按照指示打开网页查看器
oakctl app run .
```

> **您刚刚以独立模式运行了该应用。**
> 请参阅下方了解独立模式与外设模式的区别。

[继续探索其他预构建应用](https://github.com/luxonis/oak-examples/tree/main)

### 在 OAK 上运行第一个应用

#### Linux/MacOS

```bash
# 克隆仓库
git clone --depth 1 --branch main https://github.com/luxonis/oak-examples.git
# 切换到通用示例目录
cd oak-examples/neural-networks/generic-example/
# 创建并进入 Python 虚拟环境
python3 -m venv venv
source venv/bin/activate
# 安装环境依赖
pip install -r requirements.txt
# 运行应用并按照指示打开网页查看器
python3 main.py
```

#### Windows

```bash
# 克隆仓库
git clone --depth 1 --branch main https://github.com/luxonis/oak-examples.git
# 切换到通用示例目录
cd oak-examples\neural-networks\generic-example\
# 安装依赖
pip install -r requirements.txt
# 运行应用并按照指示打开网页查看器
python main.py
```

> **您刚刚以外设模式运行了该应用。**
> 请参阅下方了解独立模式与外设模式的区别。

[继续探索其他预构建应用](https://github.com/luxonis/oak-examples/tree/main)

### 独立模式 vs 外设模式

| 兼容性 | 独立模式¹ | 外设模式² |
| --- | --- | --- |
| OAK4 | ✅ | ✅ |
| OAK | 🚫 | ✅ |

 1. 独立模式：应用仅在相机上运行。通过 [oakctl](https://docs.luxonis.com/software-v3/oak-apps/oakctl.md) 部署应用。

 2. 外设模式：应用在相机上运行，但主机计算机通过 TCP 套接字与之保持连接。使用 [DepthAI API](https://docs.luxonis.com/software-v3/depthai.md) 运行应用。最适合快速原型开发和开发。

### 从头构建应用

自行开发最快的方式是使用 [模板应用](https://docs.luxonis.com/software-v3/template.md)。该应用是您自己应用的起点，包含所有必要组件，可帮助您快速上手。

```bash
# 安装核心软件包
pip install depthai --force-reinstall
# 克隆模板应用
git clone https://github.com/luxonis/oak-template.git
# 切换到模板应用目录
cd oak-template
# 安装依赖
pip install -r requirements.txt
```

这将把模板/酷客应用下载到当前目录。

```text
template-app/
├── main.py
├── oakapp.toml
├── requirements.txt
├── media/ # 可选的媒体文件
└── utils/ # 可选的辅助函数
```

[继续开发您的模板应用](https://docs.luxonis.com/software-v3/template.md)

### 后续步骤

我们建议您通过以下方式之一继续探索生态系统。

### OAK 应用

构建、打包和管理用于 OAK 设备的容器化计算机视觉应用。

[打开 OAK 应用概述](https://docs.luxonis.com/software-v3/oak-apps.md)

### DepthAI

使用 DepthAI API 在 OAK 和 OAK4 相机上构建并运行实时视觉流水线。

[打开 DepthAI 概述](https://docs.luxonis.com/software-v3/depthai.md)

### AI

探索 OAK 设备的模型部署、推理工作流和 AI 工具。

[打开 AI 概述](https://docs.luxonis.com/software-v3/ai-inference.md)