api 文档

api.md

@@ -0,0 +1,58 @@
+# 喷雾设备服务
+
+## 获取喷雾设备状态
+
+```
+GET /status
+```
+
+### 请求参数
+
+### 响应结果
+
+|  字段   | 类型 | 说明 |
+|  ----  | ----  | ---- |
+| id  | `string` | 设备唯一标识 |
+| speed1  | `int` | 喷雾量（百分比）: 0-100 |
+| speed2  | `int` | 喷雾量（百分比）: 0-100 |
+| yv1  | `int` | 电磁阀1状态: 0 停止, 1 启动 |
+| yv2  | `int` | 电磁阀2状态: 0 停止, 1 启动 |
+| is_running  | `bool` | 喷雾设备是否运行 |
+| status  | `int` | 设备状态: 0 未知, 1 在线, 2 离线 |
+| error  | `int` | 错误代码: 0 无, 1 急停, 2 低水位报警 |
+
+## 获取喷雾设备状态
+
+```
+POST /mqtt
+```
+
+### 请求参数
+
+|  字段   | 类型 | 说明 |
+|  ----  | ----  | ---- |
+| speed1  | `int` | `required` 喷雾量（百分比）: 0-100 |
+| speed2  | `int` | `required` 喷雾量（百分比）: 0-100 |
+| yv1  | `int` | `required` 电磁阀1: 0 停止, 1 启动 |
+| yv2  | `int` | `required` 电磁阀2: 0 停止, 1 启动 |
+
+### 响应结果
+
+
+#### 成功
+
+```json
+{
+    "msg": "ok"
+}
+```
+
+
+#### 失败
+
+```json
+{
+    "errcode": 400,
+    "errmsg": "参数错误"
+}
+```