> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wuji.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# 安装与环境

## 系统要求

Python SDK 和 C SDK 支持以下运行环境：

* Linux：Ubuntu 20.04 LTS（glibc 2.31）及以上版本，x86\_64 或 arm64
* macOS：11.0 及以上版本，适用于搭载 Apple 芯片（arm64）的 Mac

使用 Linux 容器部署 SDK 应用时，参见 [Docker 部署](https://docs.wuji.tech/docs/zh/wuji-sdk/latest/docker-deployment.md)。

## 安装

根据项目使用的语言选择对应的 SDK。Python 和 C SDK 可以单独安装，不要求同时安装。

### 安装 Python SDK

Python SDK 提供 CPython 3.8–3.14 的预编译 wheel。

在搭载 Apple 芯片的 Mac 上，使用 arm64 版本的 Python。安装 SDK 前，确认 Python 进程架构：

```bash theme={null}
python -c "import platform; print(platform.machine())"
```

macOS 上输出应为 `arm64`。Intel Mac 和 Rosetta 下的 x86\_64 Python 不适用该 wheel。

从 PyPI 安装 `wuji-sdk`。pip 根据 Python 版本、操作系统和架构选择对应的 wheel，支持的平台使用同一条安装命令：

```bash theme={null}
python -m pip install wuji-sdk
```

安装完成后，确认 SDK 管理器可导入：

```bash theme={null}
python -c "from wuji_sdk import SdkManager"
```

命令未出现异常，表示导入成功。

### 安装 C SDK

编译 C 程序需要 gcc 或 clang。macOS 上先安装 Xcode Command Line Tools。使用下方 CMake 示例时，还需安装 CMake。

根据目标平台选择发行包：

| 平台 | C SDK 包 |
| - | - |
| Linux x86\_64（gnu） | `wuji-sdk-c-<version>-x86_64-linux-gnu.tar.gz` |
| Linux aarch64（gnu） | `wuji-sdk-c-<version>-aarch64-linux-gnu.tar.gz` |
| Android aarch64 | `wuji-sdk-c-<version>-aarch64-android.tar.gz` |
| macOS Apple 芯片（arm64） | `wuji-sdk-c-<version>-aarch64-macos.tar.gz` |

从 [GitHub Releases](https://github.com/wuji-technology/wuji-sdk/releases) 下载目标平台的 tarball。Linux 包含 `lib/libwuji_sdk_c.so`，macOS 包含 `lib/libwuji_sdk_c.dylib`。两者都包含 `include/wuji_sdk.h` 和许可证文件。

将 `<TAG>` 替换为所下载版本的 Release 标签，并选择对应平台：

> [tab] Linux x86\_64
>
> ```bash theme={null}
> TAG="<TAG>"
> VER="${TAG#v}"
> SDK="wuji-sdk-c-${VER}-x86_64-linux-gnu"
> curl -fL "https://github.com/wuji-technology/wuji-sdk/releases/download/${TAG}/${SDK}.tar.gz" -o "${SDK}.tar.gz"
> tar xzf "${SDK}.tar.gz"
> SDK="$(pwd)/${SDK}"
> LIB="libwuji_sdk_c.so"
> ```

> [tab] macOS arm64
>
> ```bash theme={null}
> TAG="<TAG>"
> VER="${TAG#v}"
> SDK="wuji-sdk-c-${VER}-aarch64-macos"
> curl -fL "https://github.com/wuji-technology/wuji-sdk/releases/download/${TAG}/${SDK}.tar.gz" -o "${SDK}.tar.gz"
> tar xzf "${SDK}.tar.gz"
> SDK="$(pwd)/${SDK}"
> LIB="libwuji_sdk_c.dylib"
> ```

`${SDK}` 表示解压后的 tarball 根目录。确认头文件和当前平台的动态库存在：

```bash theme={null}
test -f "${SDK}/include/wuji_sdk.h" && test -f "${SDK}/lib/${LIB}" && echo "C SDK is ready"
```

编译示例时，先获取 [wuji-sdk 仓库](https://github.com/wuji-technology/wuji-sdk)中的 `examples/` 目录，再从仓库根目录运行以下命令：

```bash theme={null}
cmake -S examples/c/wuji_glove -B build \
  -DWUJI_SDK_INCLUDE_DIR="${SDK}/include" \
  -DWUJI_SDK_LIB="${SDK}/lib/${LIB}"
cmake --build build
```

编译、链接和运行 C 程序的完整说明见 [C SDK 参考](https://docs.wuji.tech/docs/zh/wuji-sdk/latest/c-sdk-reference.md)。

首次加载 `libwuji_sdk_c.dylib` 时，若 macOS 阻止加载，先确认文件来自官方 SDK 发行包，再在**系统设置 › 隐私与安全性 › 安全性**中点击**仍要打开**，然后重新运行程序。

## 设备发现与连接

安装 SDK 后，根据设备类型配置网络、USB 权限和连接方式，见[设备发现与连接](https://docs.wuji.tech/docs/zh/wuji-sdk/latest/device-connection.md)。macOS 无需配置 Linux 的 udev 规则或 `dialout` 用户组。

安装 Wuji CLI 后，可以使用以下命令检查设备发现状态：

```bash theme={null}
wuji devices
wuji ping
```

## 接口清单

| 类别 | 接口或文件 | 用途 |
| - | - | - |
| Python 包 | `wuji_sdk` | 导入 Python SDK |
| Python 管理器 | `SdkManager` | 创建 SDK 管理器实例 |
| C 头文件 | `include/wuji_sdk.h` | 提供 C API 声明 |
| C 动态库 | Linux：`lib/libwuji_sdk_c.so`，macOS：`lib/libwuji_sdk_c.dylib` | 提供 C API 实现 |
| CMake 参数 | `WUJI_SDK_INCLUDE_DIR` | 指定 C 头文件目录 |
| CMake 参数 | `WUJI_SDK_LIB` | 指定 C 动态库路径 |
| 设备发现命令 | `wuji devices` | 列出已发现的设备 |
| 设备连通性命令 | `wuji ping` | 检查设备是否响应 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.