|
|
@@ -22,7 +22,29 @@ GET /api/health
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 2. 获取所有 MQTT 配置
|
|
|
+### 2. 获取所有客户端状态
|
|
|
+
|
|
|
+```
|
|
|
+GET /api/clients
|
|
|
+```
|
|
|
+
|
|
|
+**响应示例:**
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 0,
|
|
|
+ "message": "success",
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "port": 4096,
|
|
|
+ "status": "工作中",
|
|
|
+ "code": "busy",
|
|
|
+ "timestamp": "2026-06-03T14:30:00Z"
|
|
|
+ }
|
|
|
+ ]
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+### 3. 获取所有 MQTT 配置
|
|
|
|
|
|
```
|
|
|
GET /api/mqtt
|
|
|
@@ -47,7 +69,7 @@ GET /api/mqtt
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 3. 创建 MQTT 配置
|
|
|
+### 4. 创建 MQTT 配置
|
|
|
|
|
|
```
|
|
|
POST /api/mqtt
|
|
|
@@ -91,7 +113,7 @@ POST /api/mqtt
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 4. 获取单个 MQTT 配置
|
|
|
+### 5. 获取单个 MQTT 配置
|
|
|
|
|
|
```
|
|
|
GET /api/mqtt/:id
|
|
|
@@ -119,7 +141,7 @@ GET /api/mqtt/:id
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 5. 更新 MQTT 配置
|
|
|
+### 6. 更新 MQTT 配置
|
|
|
|
|
|
```
|
|
|
PUT /api/mqtt/:id
|
|
|
@@ -159,7 +181,7 @@ PUT /api/mqtt/:id
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 6. 删除 MQTT 配置
|
|
|
+### 7. 删除 MQTT 配置
|
|
|
|
|
|
```
|
|
|
DELETE /api/mqtt/:id
|
|
|
@@ -178,7 +200,7 @@ DELETE /api/mqtt/:id
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 7. 获取所有 BLE 配置
|
|
|
+### 8. 获取所有 BLE 配置
|
|
|
|
|
|
```
|
|
|
GET /api/ble
|
|
|
@@ -201,7 +223,7 @@ GET /api/ble
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 8. 创建 BLE 配置
|
|
|
+### 9. 创建 BLE 配置
|
|
|
|
|
|
```
|
|
|
POST /api/ble
|
|
|
@@ -217,12 +239,12 @@ POST /api/ble
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-| 字段 | 类型 | 必填 | 默认值 | 说明 |
|
|
|
-|------|------|------|--------|------|
|
|
|
-| device_name | string | 否 | AI-Light | BLE 设备名称 |
|
|
|
-| service_uuid | string | 否 | b8b7e001-... | BLE 服务 UUID |
|
|
|
-| char_uuid | string | 否 | b8b7e002-... | BLE 特征 UUID |
|
|
|
-| enabled | boolean | 否 | true | 是否启用 |
|
|
|
+| 字段 | 类型 | 必填 | 说明 |
|
|
|
+|------|------|------|------|
|
|
|
+| device_name | string | 是 | BLE 设备名称 |
|
|
|
+| service_uuid | string | 是 | BLE 服务 UUID |
|
|
|
+| char_uuid | string | 是 | BLE 特征 UUID |
|
|
|
+| enabled | boolean | 否 | 是否启用 (默认 true) |
|
|
|
|
|
|
**响应示例:**
|
|
|
```json
|
|
|
@@ -239,7 +261,7 @@ POST /api/ble
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 9. 获取单个 BLE 配置
|
|
|
+### 10. 获取单个 BLE 配置
|
|
|
|
|
|
```
|
|
|
GET /api/ble/:id
|
|
|
@@ -250,7 +272,7 @@ GET /api/ble/:id
|
|
|
|------|------|------|
|
|
|
| id | integer | 配置 ID |
|
|
|
|
|
|
-### 10. 更新 BLE 配置
|
|
|
+### 11. 更新 BLE 配置
|
|
|
|
|
|
```
|
|
|
PUT /api/ble/:id
|
|
|
@@ -271,7 +293,7 @@ PUT /api/ble/:id
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-### 11. 删除 BLE 配置
|
|
|
+### 12. 删除 BLE 配置
|
|
|
|
|
|
```
|
|
|
DELETE /api/ble/:id
|
|
|
@@ -300,8 +322,51 @@ DELETE /api/ble/:id
|
|
|
|
|
|
# 方式2: 监控时同时启动 API 服务
|
|
|
./bin/opencode-monitor monitor --ports 4096 --api-addr :8080
|
|
|
+
|
|
|
+# 方式3: 启用 HTTPS (自签名证书)
|
|
|
+./bin/opencode-monitor serve --addr :8080 --tls
|
|
|
```
|
|
|
|
|
|
+## 子命令选项
|
|
|
+
|
|
|
+### serve 子命令
|
|
|
+
|
|
|
+| 选项 | 默认值 | 说明 |
|
|
|
+|------|--------|------|
|
|
|
+| `--addr` | `:8080` | 监听地址 |
|
|
|
+| `--db` | `./data/config.db` | 数据库路径 |
|
|
|
+| `--tls` | `false` | 启用 HTTPS (使用自签名证书) |
|
|
|
+| `--tls-cert` | `./data/tls/cert.pem` | TLS 证书文件路径 |
|
|
|
+| `--tls-key` | `./data/tls/key.pem` | TLS 私钥文件路径 |
|
|
|
+
|
|
|
+### monitor 子命令
|
|
|
+
|
|
|
+| 选项 | 默认值 | 说明 |
|
|
|
+|------|--------|------|
|
|
|
+| `--host` | `127.0.0.1` | 主机地址 |
|
|
|
+| `--ports` | - | 端口列表,逗号分隔 (如: 4096,4097,4098) |
|
|
|
+| `--scan` | - | 扫描端口范围 (如: 4096-4100) |
|
|
|
+| `--interval` | `1` | 动态扫描间隔(秒) |
|
|
|
+| `--api-addr` | - | API 服务地址 (如: :8080) |
|
|
|
+| `--db` | `./data/config.db` | 数据库路径 |
|
|
|
+| `--tls` | `false` | 启用 HTTPS (使用自签名证书) |
|
|
|
+| `--tls-cert` | `./data/tls/cert.pem` | TLS 证书文件路径 |
|
|
|
+| `--tls-key` | `./data/tls/key.pem` | TLS 私钥文件路径 |
|
|
|
+
|
|
|
+### config 子命令
|
|
|
+
|
|
|
+| 选项 | 默认值 | 说明 |
|
|
|
+|------|--------|------|
|
|
|
+| `--db` | `./data/config.db` | 数据库路径 |
|
|
|
+
|
|
|
+### version 子命令
|
|
|
+
|
|
|
+```bash
|
|
|
+./bin/opencode-monitor version
|
|
|
+```
|
|
|
+
|
|
|
+显示版本信息。
|
|
|
+
|
|
|
## 全局选项
|
|
|
|
|
|
以下选项适用于 `monitor`、`serve`、`config` 三个子命令:
|
|
|
@@ -379,15 +444,11 @@ API 已启用 CORS,支持跨域请求。
|
|
|
# 一键构建(打包 Python 脚本 + 嵌入 Go 二进制)
|
|
|
make build-with-ble
|
|
|
|
|
|
-# 或手动两步
|
|
|
-scripts\build_ble_relay.bat
|
|
|
-go build -tags ble -o bin/opencode-monitor.exe ./cmd/monitor
|
|
|
-```
|
|
|
-
|
|
|
-### Python 依赖(仅开发时需要)
|
|
|
-
|
|
|
-```bash
|
|
|
-pip install -r scripts/requirements.txt
|
|
|
+# 或手动步骤
|
|
|
+python -m PyInstaller --onefile --name ble_relay --distpath bin scripts/ble_relay.py
|
|
|
+cp bin/ble_relay cmd/monitor/ble_relay
|
|
|
+go build -tags ble -o bin/opencode-monitor ./cmd/monitor
|
|
|
+rm -f cmd/monitor/ble_relay
|
|
|
```
|
|
|
|
|
|
### 状态映射
|