# 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-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DJI Cloud API Documentation

This project contains the official API documentation for DJI Pilot 2 and DJI Dock series products, designed to provide developers with comprehensive technical documentation and development guides.

## Document Overview

The DJI Cloud API supports multiple protocol access methods to meet communication requirements in various scenarios:

- **MQTT Protocol**: Supports real-time bidirectional communication, suitable for scenarios such as status reporting and command control.
- **HTTPS Interfaces**: Suitable for business interfaces including map element management, flight path management, and media management.
- **WebSocket**: Supports real-time message push.
- **JSBridge**: Enables interaction between the Pilot application and WebView.

## Document Structure

```
├── src/
│   ├── 00.index.md              # Release Notes
│   ├── 01.tutorial-map.md       # Document Reading Guide
│   ├── 02.flight-safety-notification.md  # Flight Safety Notice
│   ├── 10.overview/             # Product Overview and Basic Concepts
│   │   ├── 10.product-introduction.md
│   │   ├── 20.product-architecture.md
│   │   ├── 30.product-support.md
│   │   └── 40.basic-concept/    # MQTT, Thing Model, WebSocket, JSBridge, etc.
│   ├── 20.quick-start/          # Quick Start Guide
│   │   ├── 10.environment-prepare-list.md
│   │   ├── 20.source-code-deployment-steps.md
│   │   ├── 30.docker-deployment-steps.md
│   │   └── 40.function-display-video.md
│   ├── 30.feature-set/          # Feature Set Details
│   │   ├── 10.pilot-feature-set/    # Pilot Cloud Features
│   │   └── 20.dock-feature-set/     # Dock Cloud Features
│   ├── 50.debug/                # Debugging Guide
│   ├── 60.api-reference/        # API Reference Documentation
│   ├── 71.error-code.md         # Error Code Reference
│   └── 80.faq.md                # Frequently Asked Questions
├── .vitepress/                  # VitePress Configuration
├── conf.d/                      # Nginx Configuration
├── Dockerfile                   # Docker Build File
└── package.json
```

## Supported Products

### Pilot Cloud

- M3 Series Drones
- M30/M30T Drones
- RC Pro Remote Controller

### Dock Cloud

- DJI Dock 1 (Dock1)
- DJI Dock 2 (Dock2)
- DJI Dock 3 (Dock3)

## Quick Start

### System Requirements

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

### Local Development

1. Install dependencies:

```bash
npm install
```

2. Start the development server:

```bash
npm run dev
```

3. Build the production version:

```bash
npm run build
```

4. Preview the production build:

```bash
npm run preview
```

### Docker Deployment

1. Build the image:

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

2. Run the container:

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

## Key Features

### Pilot Cloud Features

- Device Cloud Connection and Disconnection
- Situational Awareness
- Live Streaming
- Map Element Management
- Media Management
- Flight Path Management
- Command-based Flight (DRC)
- Remote Log Retrieval

### Dock Cloud Features

- Device Management
- Flight Path Management
- Media Management
- Live Streaming
- HMS Health Management
- Remote Debugging
- Firmware Upgrade
- Remote Log Retrieval
- Custom Flight Zones
- Jump Mission
- AI Target Recognition

## Release History

Refer to [Release Notes](./src/00.index.md) for release dates, new features, and supported product lists for each version.

## Frequently Asked Questions

Refer to [FAQ](./src/72.faq.md) for answers to common questions.

## Contribution Guidelines

Contributors are welcome to submit Issues or Pull Requests to improve documentation quality.

## License

This documentation is copyrighted by DJI Innovations.

## Contact Us

For questions or suggestions, please seek technical support via the DJI Developer Platform.