# aimdk

**Repository Path**: hawkTTking/aimdk

## Basic Information

- **Project Name**: aimdk
- **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-06-01
- **Last Updated**: 2026-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 灵犀X2 AimDK 使用说明

## 文档

X2 AimDK文档采用网页形式, 包括:
- [本地文档](docs/cn/_build/html) - 随SDK发布的初始文档
- [在线文档](https://x2-aimdk.agibot.com) - 动态更新

### 本地文档查阅

可通过如下方式(假设使用端口5789, 根据占用情况可自行改为其他端口):

1. 运行本地网页服务器:

```bash
sh ./run_docs.sh 5789
```

2. 成功启动后, 浏览器输入 <http://127.0.0.1:5789> 即可访问

**注意: 本地文档缺少动态堪误与更新, 请优先查阅在线文档**

### 在线文档查阅(推荐)

浏览器直接访问 <https://x2-aimdk.agibot.com>

页面加载后, 从浮动工具栏选择与本SDK版本一致的文档即可


## AimDK 接口与例程

请参见文档相关章节

## 二开用户数据保存

目前固件升/降级会清理机器人系统内的文件。如需跨固件版本保留数据，请:

1. 将数据存放`$HOME`(/agibot/data/home/agi)目录下, 此处数据默认跨固件留存, 但需注意:
   + `$HOME`下`aimdk`开头的目录为系统预留, 系统自动维护, 数据放入其中可能被清除
   + 谨慎使用一键恢复出厂设置类功能, 恢复过程用户数据可能强制清除
2. 定期/切换版本前, 将机上数据备份出来