Преглед изворни кода

添加定时任务字段定义

miricy пре 1 година
родитељ
комит
cc50786df4
1 измењених фајлова са 53 додато и 5 уклоњено
  1. 53 5
      product/deviceconfig.md

+ 53 - 5
product/deviceconfig.md

@@ -106,9 +106,19 @@ key: 用户授权token,服务器为设备分配的长期有有效的授权token
 
 ## 背景图片列表
 
-### GET 请求URL
+### GET请求URL
 
-{{api_url}}/v1/device/configs/background
+{{api_url}}/v1/device/configs/background?deviceId=ac:bc:cd:ee:11:22
+
+### 请求头参数
+
+Content-Type: application/json
+Authorization: Bearer {{key}}
+
+### 请求参数
+
+deviceId: 设备唯一标识
+key: 用户授权token,服务器为设备分配的长期有有效的授权token,内置在设备中,无需用户手动获取。
 
 ### 返回结果
 
@@ -172,16 +182,19 @@ key: 用户授权token,服务器为设备分配的长期有有效的授权token
 
 ### GET请求URL
   
-  {{api_url}}/v1/device/configs/:deviceId/:scope
+  {{api_url}}/v1/device/configs/sync?deviceId=ac:bc:cd:ee:11:22&type=all
 
-### HEAD 参数
+### 请求头参数:
+Content-Type: application/json
+Authorization: Bearer {{key}}
 
 ### 查寻参数
 
 | 参数名   |   参数类型   | 值    | 说明              |
 | -------- | ------------ | --------------------- | -------------------------------------------------                 |
 | deviceId | string   | ac:bc:cd:ee:11:22     | 设备ID或MAC地址,必须字段,后台添加限制时保持一致即可,智能家居应用目前定为大写MAC去冒号 |
-| type     | string   | device |  获取哪些配置 all和不传为所有,device为设备配置列表,scene为场景配置列表,area为区域配置列表,all为所有组合配置
+| type     | string   | device |  获取哪些配置 all和不传为所有,device为设备配置列表,scene为场景配置列表,area为区域配置列表,all为所有组合配置 |
+                         |
 
 ### 返回结果
 
@@ -844,6 +857,7 @@ key: 用户授权token,服务器为设备分配的长期有有效的授权token
     }
   },
 ]
+```
 
 ### 暖通设备,空调新风地暖配置数据示例
 
@@ -1268,6 +1282,7 @@ key: 用户授权token,服务器为设备分配的长期有有效的授权token
 ```
 
 ### 智能系统区域数据格式
+
 区域中顶级区域即工程区域,父级为0或空的区域,即工程区域,可作为单个工程唯一id
 
 ```json
@@ -1484,3 +1499,36 @@ android 配置存放路径:/vendor/etc/homeapp/hardware.cfg
             ] //GPIO配置列表,gpio对应的继电器地址列表,按顺序排列
 }
 ```
+
+## 定时任务字段和格式定义
+
+定时任务分为面板定制执行任务和网关定时执行任务
+
+### 面板定时执行任务
+
+  面板定时执行任务,定时任务执行时,面板会按照定时规则,本地执行任务中的场景
+  面板执行任务只在面板端添加,不通过网关执行
+
+### 网关定时执行任务
+
+  网关定时执行任务,定时任务执行时,网关会按照定时规则,执行任务中的场景
+  网关定时任务,一般为后台管理任务,只在后台添加
+
+#### 定时任务数据字段定义
+
+| 字段名 | 类型 | 说明                                 |
+| ------- | ------- | ------------------------------------- |
+| bid       | String  | 定时任务ID,唯一标识,UUID标识            |
+| type     | int     | 任务类型,0本地   1网关              |
+| repeat_mode | int   | 任务重复执行模式,0永不重复   1重复    |
+| open     | int     | 任务状态,0关闭   1开启              |
+| year     | int     | 年,重复执行模式默认为0                  |
+| month    | int     | 月,重复执行模式默认为0                  |
+| day      | int     | 日,重复执行模式默认为0                  |
+| weeks    | String  | 星期,永不重复模式下也需要填写,1-7对应周一到周日 |
+| hour     | int     | 时                                   |
+| minute   | int     | 分                                   |
+| second   | int     | 秒                                   |
+| panel_id  | String  | 面板ID                               |
+| scene_id  | String  | 场景ID                               |
+