# uavs_api_docs

**Repository Path**: kingkoo1985/uavs_api_docs

## Basic Information

- **Project Name**: uavs_api_docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-02
- **Last Updated**: 2026-02-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 大疆上云 API 文档

本项目包含 DJI Pilot 2 和大疆机场系列产品的上云 API 官方文档，旨在为开发者提供完整的技术文档和开发指南。

## 文档简介

大疆上云 API 提供多种协议接入方式，满足不同场景的通信需求：

- **MQTT 协议**：支持实时双向通信，适用于状态推送、指令控制等场景
- **HTTPS 接口**：适用于地图元素管理、航线管理、媒体管理等业务接口
- **WebSocket**：支持消息实时推送
- **JSBridge**：支持 Pilot 应用与 Webview 之间的交互

## 文档结构

```
├── src/
│   ├── 00.index.md              # 版本发布记录
│   ├── 01.tutorial-map.md       # 文档阅读指引
│   ├── 02.flight-safety-notification.md  # 安全飞行须知
│   ├── 10.overview/             # 产品概述与基础概念
│   │   ├── 10.product-introduction.md
│   │   ├── 20.product-architecture.md
│   │   ├── 30.product-support.md
│   │   └── 40.basic-concept/    # MQTT、物模型、WebSocket、JSBridge 等
│   ├── 20.quick-start/          # 快速开始指南
│   │   ├── 10.environment-prepare-list.md
│   │   ├── 20.source-code-deployment-steps.md
│   │   ├── 30.docker-deployment-steps.md
│   │   └── 40.function-display-video.md
│   ├── 30.feature-set/          # 功能集详解
│   │   ├── 10.pilot-feature-set/    # Pilot 上云功能
│   │   └── 20.dock-feature-set/     # 机场上云功能
│   ├── 50.debug/                # 调试指南
│   ├── 60.api-reference/        # API 参考文档
│   ├── 71.error-code.md         # 错误码说明
│   └── 80.faq.md                # 常见问题
├── .vitepress/                  # VitePress 配置
├── conf.d/                      # Nginx 配置
├── Dockerfile                   # Docker 构建文件
└── package.json
```

## 支持产品

### Pilot 上云

- M3 系列飞行器
- M30/M30T 飞行器
- RC Pro 遥控器

### 机场上云

- 大疆机场 1 (Dock1)
- 大疆机场 2 (Dock2)
- 大疆机场 3 (Dock3)

## 快速开始

### 环境要求

- Node.js 18+
- npm 9+
- Docker & Docker Compose (可选)

### 本地开发

1. 安装依赖：

```bash
npm install
```

2. 启动开发服务器：

```bash
npm run dev
```

3. 构建生产版本：

```bash
npm run build
```

4. 预览生产构建：

```bash
npm run preview
```

### Docker 部署

1. 构建镜像：

```bash
docker build -t uavs-api-docs .
```

2. 运行容器：

```bash
docker run -d -p 80:80 uavs-api-docs
```

## 主要功能

### Pilot 上云功能

- 设备上云与下云
- 态势感知
- 直播功能
- 地图元素管理
- 媒体管理
- 航线管理
- 指令飞行 (DRC)
- 远程日志获取

### 机场上云功能

- 设备管理
- 航线管理
- 媒体管理
- 直播功能
- HMS 健康管理
- 远程调试
- 固件升级
- 远程日志
- 自定义飞行区
- 蛙跳任务
- AI 目标识别

## 版本历史

详见 [版本发布记录](./src/00.index.md)，包含各版本的发布日期、新增功能和支持产品列表。

## 常见问题

详见 [FAQ](./src/72.faq.md)，获取常见问题的解答。

## 贡献指南

欢迎开发者提交 Issue 或 Pull Request 改进文档质量。

## 许可证

本项目文档版权归大疆创新所有。

## 联系我们

如有问题或建议，请通过大疆开发者平台获取技术支持。