# 设备管理

## 1. 准备

**基础域名**：`https://api.rokid.com`

**准备**：
- 确保已经获取到了有效的API密钥（`API_KEY`），用于身份验证。
- 确保设备已经在灵眸平台上`设备管理`（`https://x-inspection.rokid.com/main/devices` ）完成注册。

## 2. 功能介绍
设备管理模块提供了设备的注册、查询、删除等功能，帮助开发者获取眼镜的设备信息和状态。

### 2.1 查询设备列表
**接口地址**:`https://api.rokid.com/ar/core/openapi/device/list`

**请求方式**:`POST`

**请求数据类型**:`application/json`

**响应数据类型**:`*/*`

**接口描述**: 查询设备列表

**请求参数**:

| **参数名称** | **参数说明** | **是否必须** | **数据类型** |
| --- | --- | --- | --- |
| deviceSn | 设备SN号，支持模糊查询 | false | string |
| deviceName | 设备名称，支持模糊查询 | false | string |

**输出结果：**

| **参数名称** | **参数说明** | **是否必须** | **数据类型** |
| --- | --- | --- | --- |
| deviceSn | 设备SN号，支持模糊查询 | true | string |
| deviceName | 设备名称，支持模糊查询 | true | string |
| deviceType | 设备类型：<br>GLASS3 企业版GLASS3\_LITE 暴龙版<br>GLASS\_OTHER 其他 | true | string |
| status | 在线状态：<br>online 在线<br>offline 离线 | true | string |

**请求示例：**

```json
curl -X POST https://api.rokid.com/ar/core/openapi/device/list \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "deviceSn":"设备SN号",
    "deviceName":"设备名称"
}'
```

**响应示例**:

```json
{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "deviceName": "glass3_001715",
      "deviceSn": "1901092524001715",
      "deviceType": "GLASS3",
      "status": "offline"
    }
  ],
  "success": true
}
```

### 2.2 查询设备详情
**接口地址**:`https://api.rokid.com/ar/core/openapi/device/detail?deviceSn={$deviceSn}`

**请求方式**:`GET`

**请求数据类型**:`application/json`

**响应数据类型**:`*/*`

**接口描述**: 查询设备详情

**请求参数**:

| **参数名称** | **参数说明** | **是否必须** | **数据类型** |
| --- | --- | --- | --- |
| deviceSn | 设备SN号 | true | string |

**输出结果：**

| **参数名称** | **参数说明** | **是否必须** | **数据类型** |
| --- | --- | --- | --- |
| deviceSn | 设备SN号，支持模糊查询 | true | string |
| deviceName | 设备名称，支持模糊查询 | true | string |
| deviceType | 设备类型：<br>GLASS3 企业版GLASS3\_LITE 暴龙版<br>GLASS\_OTHER 其他 | true | string |
| status | 在线状态：<br>online 在线<br>offline 离线 | true | string |

**请求示例：**

```json
curl -X GET https://api.rokid.com/ar/core/openapi/device/detail?deviceSn=1901092524001715 \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json"
```

**响应示例**:

```json
{
  "code": 0,
  "message": "OK",
  "data": {
    "deviceName": "glass3_001715",
    "deviceSn": "1901092524001715",
    "deviceType": "GLASS3",
    "status": "offline"
  },
  "success": true
}
```

### 2.1 查询设备实时数据
**接口地址**:`https://api.rokid.com/ar/core/openapi/device/realData?deviceSn={$deviceSn}`

**请求方式**:`GET`

**请求数据类型**:`application/json`

**响应数据类型**:`*/*`

**接口描述**: 查询设备实时数据

**请求参数**:

| **参数名称** | **参数说明** | **是否必须** | **数据类型** |
| --- | --- | --- | --- |
| deviceSn | 设备SN号 | true | string |

**输出结果：**

| **参数名称** | **参数说明** | **是否必须** | **数据类型** |
| --- | --- | --- | --- |
| powerValue | 电量百分比 | true | int |
| currentUserId | 当前使用用户uid | true | string |

**请求示例：**

```json
curl -X GET https://api.rokid.com/ar/core/openapi/device/detail?deviceSn=1901092524001715 \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" 
```

**响应示例**:

```json
{
  "code": 0,
  "message": "OK",
  "data": {
    "powerValue": 100,
    "currentUserId": "E0BB5354E9F54BC6A032E8B709CC7B2E"
  },
  "success": true
}
```