zhangwd 11 miesięcy temu
rodzic
commit
36c323c280

+ 13 - 0
zh-cn/fxsnew/_sidebar.md

@@ -0,0 +1,13 @@
+* [性诱2.0http协议](/zh-cn/fxsnew/fxsnew?id=性诱2.0http协议)
+
+  * [简述](/zh-cn/fxsnew/fxsnew?id=简述)
+
+    * [通信描述](/zh-cn/fxsnew/fxsnew?id=通信描述)
+
+      * [对接说明](/zh-cn/fxsnew/fxsnew?id=对接说明)
+
+      * [设备数据说明](/zh-cn/fxsnew/fxsnew?id=设备数据说明)
+
+      * [设备数据报文结构](/zh-cn/fxsnew/fxsnew?id=设备数据报文结构)
+
+      * [设备数据](/zh-cn/fxsnew/fxsnew?id=设备数据)

+ 119 - 0
zh-cn/fxsnew/fxsnew.md

@@ -0,0 +1,119 @@
+# 风吸式杀虫灯通讯约定
+
+## 1.1 简述
+本文档主要用于阐述风吸式杀虫灯与服务器端进行交互的通讯细节。
+
+## 1.2 通信描述
+对接采用 HTTP 协议,由接收方写接口来接收 HTTP POST 数据(需从 request 的 body(字节流类型)中取数据,取到之后进行 JSON 解析)。
+
+## 1.3 对接说明
+1. **设备数据说明**:
+   - 数据上传时间默认为30分钟一次。
+   
+2. **设备对接说明**:
+   - 设备数据包含(设备号、SIM卡号、环境温湿度、工作状态、经纬度、电压等)。
+   - 由接收方提供接口接收数据,设备方推送数据。
+   - 先进行接口测试,没问题后才能发正式数据。
+   - 如果对接完成后设备未收到数据,请先检查所提供的接口是否有问题,然后再联系对接人员。
+   - 设备上线后会自动发送数据。
+   - 关于接口安全问题,可以针对传输方IP做限制,不是传输方的IP不让其调用接口(传输方IP可以联系对接人员提供)。
+   - 设备数据格式不可变,不能按接收方增加或者减少字段,如有需求请联系销售经理。
+   - 接口设置是我们这边进行配置,您只需要把接口发给对接人员就可以了。
+
+## 1.4 设备数据报文结构
+
+### 1.4.1 报文结构
+```json
+{
+	"topic": "/yfkj/fxs/pub/860048073380360",
+	"payload": {
+		"cmd": "data",
+		"ext": {
+			"ds": "1",
+			"dver": "4.0.10-4G-FXS-uart",
+			"lcm": "0",
+			"dat_f": "10",
+			"lat": "29.3025136",
+			"st": "20",
+			"tt": "4",
+			"lng": "106.2887516",
+			"imei": "860048073380360",
+			"ah": "84",
+			"cv": "17.218",
+			"iccid": "898604E3162390281873",
+			"rcnt": "11",
+			"vps": "0",
+			"voltval": "0",
+			"stamp": "20241104084444",
+			"stm8vs": "FXS-Beta-V2.0.3",
+			"tps": "0",
+			"gps": "1",
+			"ts": "0",
+			"ws": "0",
+			"et": "2",
+			"csq": "28",
+			"dps": "0",
+			"ct": "0",
+			"dtype": "2",
+			"at": "19",
+			"bt": "22.1",
+			"bv": "13.15",
+			"rps": "0",
+			"clt_t": "30",
+			"lps": "1",
+			"cycle_off": "0",
+			"clear_on": "0"
+		}
+	}
+}
+```
+1.4.2 字段说明  
+
+字段	含义或表示的内容
+dver	物联网模块代码版本号
+lcm	光控类型 0 太阳能板光控 1 光敏二极管光控
+dat_f	数据上报时间间隔
+st	时控开始时间
+tt	光控工作时长 默认4小时
+lng	经度
+imei	唯一ID
+ah	环境湿度
+cv	充电电压 单位:V 字符串
+iccid	SIM卡卡号
+rcnt	设备启动次数
+vps	欠压保护
+voltval	灯管状态
+stamp	系统时间
+stm8vs	主板代码版本
+tps	温控保护
+gps	定位方式 0 手动定位 1 GPS定位 2 基站定位
+ts	时控开关
+ws	工作状态 0待机,1工作, 2充电
+et	时控结束时间
+csq	信号强度
+dps	倾倒保护
+ct	风扇状态
+dtype	设备类型 2:4G杀虫灯
+at	环境温度
+bt	主板温度 默认25度
+bv	电池电压 单位:V 字符串
+rps	雨控保护
+clt_t	自清虫时间间隔
+lps	是否光控 0 晚上 1 白天
+cycle_off	放电截止频率
+clear_on	自清虫标志位
+1.5 遗愿消息
+设备默认设置配置了 MQTT 遗愿消息。当设备异常下线时(客户端断开前未向服务器发送 DISCONNECT 消息),MQTT 消息服务器会发布异常下线设备的遗愿消息。
+
+1.5.1 报文结构
+```json
+{
+	"payload": {
+		"cmd": "offline",
+		"ext": {
+			"imei": "867435052203452"
+		}
+	},
+	"topic": "/yfkj/fxs/pub/867435052203452"
+}
+```

+ 13 - 0
zh-cn/lsgssq/_sidebar.md

@@ -0,0 +1,13 @@
+* [性诱2.0http协议](/zh-cn/xy2/xy2?id=性诱2.0http协议)
+
+  * [简述](/zh-cn/xy2/xy2?id=简述)
+
+    * [通信描述](/zh-cn/xy2/xy2?id=通信描述)
+
+      * [对接说明](/zh-cn/xy2/xy2?id=对接说明)
+
+      * [设备数据说明](/zh-cn/xy2/xy2?id=设备数据说明)
+
+      * [设备数据报文结构](/zh-cn/xy2/xy2?id=设备数据报文结构)
+
+      * [设备数据](/zh-cn/xy2/xy2?id=设备数据)

+ 71 - 0
zh-cn/lsgssq/xy2.md

@@ -0,0 +1,71 @@
+# 性诱2.0http协议
+
+## 简述
+
+本文档主要用于阐述性诱测报与服务端进行交互的通讯细节。
+
+## 通信描述
+
+对接采用 HTTP 协议,由接收方写接口来接收 HTTP POST 数据(需从 request 的 body(字节流类型)中取数据,取到之后进行 JSON 解析)。
+
+## 对接说明
+
+### 设备数据说明
+
+1. **设备数据分为两种**:
+   - **第一种(设备数据)**:30 分钟上传一次。
+   - **第二种(击杀计数)**:只要捕获到害虫就会触发上传一次。
+2. **设备数据包含**:设备号、环境温湿度、工作状态、电压等。
+3. **数据格式不可变**:设备数据格式不可变,不能按接收方增加或者减少字段,如有需求请联系销售经理。
+4. **接口安全**:可以针对传输方 IP 做限制,非传输方 IP 不允许调用接口(传输方 IP 可以联系对接人员提供)。
+5. **设备离线问题**:如果未及时收到 30 分钟上传一次的设备数据,说明设备离线。
+6. **接口设置**:由我们这边进行配置,您只需要把接口发给对接人员就可以了。
+
+## 设备数据报文结构
+
+### 设备数据
+
+```json
+{
+  "b_v": "23.5",
+  "b_c": "23.7",
+  "p_v": "23.8",
+  "p_c": "23.9",
+  "uptime": "2021-05-25 17:41:26",
+  "at": "35",
+  "ah": "23",
+  "warn": "",
+  "imei": "e20210106947931",
+  "protocoltype": 2
+}
+```
+字段说明  
+
+| 字段名   | 描述                     |
+| -------- | ------------------------ |
+| imei     | 通讯板唯一 ID            |
+| uptime   | 数据采集时间             |
+| protocoltype | 数据类型 2:设备数据 |
+| at       | 环境温度                 |
+| ah       | 环境湿度                 |
+| b_v      | 电池电压                 |
+| b_c      | 电池电流                 |
+| p_v      | 太阳能板电压             |
+| p_c      | 太阳能板电流             |
+| warn     | 警告信息                 |  
+
+设备击杀计数  
+```json
+{
+  "pest": 1,
+  "imei": "e20210106947931",
+  "protocoltype": 3
+}
+```
+字段说明  
+
+| 字段名       | 描述                     |
+| ------------ | ------------------------ |
+| imei         | 通讯板唯一 ID            |
+| protocoltype | 数据类型 3:杀虫计数     |
+| pest         | 击杀计数                 |

+ 6 - 5
zh-cn/qxz/qxz.md

@@ -48,6 +48,7 @@
 | eValue       | 数据结果(注:若数值为 -99.99,则表示传感器故障或未连接)            |
 | eKey         | 通道编号(从 e1 开始)                                               |
 | eNum         | 通道对应要素名称及单位                                               |  
+
 运行基本状态信息上传
 开机上报(1次)
 ```json
@@ -294,9 +295,9 @@
             "IMEI": "866262042538503",
             "ICCID": "89860411101892475452",
             "longitude": "113.604943",
-            "latitude": "34.847540"
-            "altitude": "105.3"
-            "version": "1.0.0_2020/07/15/10/09_alpha"
+            "latitude": "34.847540",
+            "altitude": "105.3",
+            "version": "1.0.0_2020/07/15/10/09_alpha",
             "dotled": "0"
         }
     }
@@ -453,7 +454,7 @@
 
 
 ## 遗愿消息
-topic:/yfkj/qxz/offline/<imei>
+topic:/yfkj/qxz/offline/imei  
 报文结构:
 ```json
 {
@@ -464,7 +465,7 @@ topic:/yfkj/qxz/offline/<imei>
 }
 ```
 ## 开机上报在线消息
-topic:/yfkj/qxz/offline/<imei>
+topic:/yfkj/qxz/offline/imei  
 报文结构:
 ```json
 {

+ 7 - 7
zh-cn/xy2/_sidebar.md

@@ -1,13 +1,13 @@
-* [吸虫塔http协议](/zh-cn/xct/xct?id=吸虫塔http协议)
+* [性诱2.0http协议](/zh-cn/xy2/xy2?id=性诱2.0http协议)
 
-  * [简述](/zh-cn/xct/xct?id=简述)
+  * [简述](/zh-cn/xy2/xy2?id=简述)
 
-    * [通信描述](/zh-cn/xct/xct?id=通信描述)
+    * [通信描述](/zh-cn/xy2/xy2?id=通信描述)
 
-      * [对接说明](/zh-cn/xct/xct?id=对接说明)
+      * [对接说明](/zh-cn/xy2/xy2?id=对接说明)
 
-      * [设备数据、图片数据说明](/zh-cn/xct/xct?id=设备数据、图片数据说明)
+      * [设备数据说明](/zh-cn/xy2/xy2?id=设备数据说明)
 
-      * [设备对接说明](/zh-cn/xct/xct?id=设备对接说明)
+      * [设备数据报文结构](/zh-cn/xy2/xy2?id=设备数据报文结构)
 
-      * [设备数据报文结构](/zh-cn/xct/xct?id=设备数据报文结构)
+      * [设备数据](/zh-cn/xy2/xy2?id=设备数据)

+ 3 - 2
zh-cn/xy2/xy2.md

@@ -1,4 +1,4 @@
-# 性诱测报与服务端交互通讯细节
+# 性诱2.0http协议
 
 ## 简述
 
@@ -52,7 +52,8 @@
 | b_c      | 电池电流                 |
 | p_v      | 太阳能板电压             |
 | p_c      | 太阳能板电流             |
-| warn     | 警告信息                 |
+| warn     | 警告信息                 |  
+
 设备击杀计数  
 ```json
 {

+ 8 - 4
zh-cn/xycb/_sidebar.md

@@ -18,10 +18,14 @@
 
     * [适用范围](/zh-cn/xycb/xycb?id=适用范围)
 
-      * [对接说明](/zh-cn/xycb/xycb?id=对接说明)
+      * [设备主题](/zh-cn/xycb/xycb?id=设备主题)
 
-      * [设备数据说明](/zh-cn/xycb/xycb?id=设备数据说明)
+      * [MQTT协议版本](/zh-cn/xycb/xycb?id=MQTT协议版本)
 
-      * [设备对接说明](/zh-cn/xycb/xycb?id=设备对接说明)
+      * [交互协议](/zh-cn/xycb/xycb?id=交互协议)
 
-      * [设备数据报文结构](/zh-cn/xycb/xycb?id=设备数据报文结构)
+      * [报文分类](/zh-cn/xycb/xycb?id=报文分类)
+
+      * [报文结构](/zh-cn/xycb/xycb?id=报文结构)
+
+      * [遗愿消息](/zh-cn/xycb/xycb?id=遗愿消息)

+ 88 - 43
zh-cn/xycb/xycb.md

@@ -119,7 +119,7 @@
 ```  
 
 
-# 物联网性诱设备通讯约定
+# 性诱测报mqtt协议
 
 ## 简述
 本文档主要用于阐述物联网性诱设备与服务器端进行交互的通讯细节,其中包括物联网性诱设备与服务器之间使用的通信协议和交互通讯协议两部分。
@@ -154,10 +154,10 @@
   "ext": "<message>"
 }
 ```
-cmd: 协议命令字,对应报文分类定义的英文标识。
-ext: 各个命令字对应的信息内容。
-以上数据内容为 json 格式。
-上行通信
+cmd: 协议命令字,对应报文分类定义的英文标识。  
+ext: 各个命令字对应的信息内容。  
+以上数据内容为 json 格式。  
+上行通信  
 报文结构
 ```json
 {
@@ -198,42 +198,45 @@ ext: 各个命令字对应的信息内容。
   }
 }
 ```
-字段说明
-字段	描述
-imei	通讯板唯一 ID
-iccid	SIM 卡卡号
-csq	信号强度 0~30
-dver	4G 物联网模块代码版本号
-proj	设备名称
-dtype	设备类型 (性诱 I 设备类型为 4)
-btype	电池类型 0:蓄电池 1:锂电池
-ds	设备开关 0:关机 1:开机
-ws	工作状态 0:待机 1:工作
-cs	充电标志位 0:非充电 1:充电
-rps	雨控状态 0:正常 1:保护
-tps	温控状态 0:正常 1:保护
-dps	倾倒状态 0:正常 1:保护
-bs	电池状态 0:正常 1:欠压 2:过压
-ts	时控开关 0:关闭时控 1:开启时控
-st	时控开始时间 单位:小时 0~24
-et	时控结束时间 单位:小时 0~24
-cv	充电电压 单位:V 字符串类型
-bv	电池电压 单位:V 字符串类型
-at	环境温度 (字符串)
-ah	环境湿度 (字符串)
-infr_ct	红外计数值 整型
-volt_ct	高压计数值 整型
-dat_f	数据上传时间间隔 单位:分钟
-clt_t	清虫间隔 单位:分钟
-wind_drec	风向 整型 范围 0~359
-wind_sped	风速 字符串 单位: m/s
-rcnt	设备重启次数
-gps	定位方式 0 手动定位 1 GPS 定位 2 基站定位
-lng	经度
-lat	纬度
-stamp	时间戳 20180301211805
-下行通信
-下发查询请求
+字段说明  
+
+| 字段     | 描述                               |
+|----------|------------------------------------|
+| imei     | 通讯板唯一 ID                      |
+| iccid    | SIM 卡卡号                         |
+| csq      | 信号强度 0~30                      |
+| dver     | 4G 物联网模块代码版本号            |
+| proj     | 设备名称                           |
+| dtype    | 设备类型 (性诱 I 设备类型为 4)     |
+| btype    | 电池类型 0:蓄电池 1:锂电池       |
+| ds       | 设备开关 0:关机 1:开机           |
+| ws       | 工作状态 0:待机 1:工作           |
+| cs       | 充电标志位 0:非充电 1:充电       |
+| rps      | 雨控状态 0:正常 1:保护           |
+| tps      | 温控状态 0:正常 1:保护           |
+| dps      | 倾倒状态 0:正常 1:保护           |
+| bs       | 电池状态 0:正常 1:欠压 2:过压   |
+| ts       | 时控开关 0:关闭时控 1:开启时控   |
+| st       | 时控开始时间 单位:小时 0~24        |
+| et       | 时控结束时间 单位:小时 0~24        |
+| cv       | 充电电压 单位:V 字符串类型         |
+| bv       | 电池电压 单位:V 字符串类型         |
+| at       | 环境温度 (字符串)                  |
+| ah       | 环境湿度 (字符串)                  |
+| infr_ct  | 红外计数值 整型                    |
+| volt_ct  | 高压计数值 整型                    |
+| dat_f    | 数据上传时间间隔 单位:分钟        |
+| clt_t    | 清虫间隔 单位:分钟                |
+| wind_drec| 风向 整型 范围 0~359               |
+| wind_sped| 风速 字符串 单位: m/s              |
+| rcnt     | 设备重启次数                       |
+| gps      | 定位方式 0 手动定位 1 GPS 定位 2 基站定位 |
+| lng      | 经度                               |
+| lat      | 纬度                               |
+| stamp    | 时间戳 20180301211805              |  
+
+下行通信  
+下发查询请求  
 查询数据报文结构:
 ```json
 {
@@ -241,7 +244,7 @@ stamp	时间戳 20180301211805
   "ext": "data"
 }
 ```
-控制指令下发
+控制指令下发  
 下发定时控制报文结构
 ```json
 {
@@ -269,9 +272,51 @@ stamp	时间戳 20180301211805
   }
 }
 ```
-下发清虫动作
+下发清虫动作  
 ```json
 {
   "cmd": "clearworm"
 }
 ```
+下发重启报文结构  
+```json
+{
+  "cmd": "reboot"
+}
+```
+下发升级报文结构  
+```json
+{
+  "cmd": "update"
+}
+```
+字段说明  
+
+| 字段      | 描述                                                         |
+|-----------|--------------------------------------------------------------|
+| cmd       | `paramconf`                                                  |
+| work_tim  | 下发配置定时控制参数:<br> - `timctrl`: 时控开关,0 关闭时控,1 开启时控 <br> - `st`: 开始时间 <br> - `et`: 结束时间 |
+| data_tim  | 下发配置数据上报时间间隔,单位:分钟                         |
+| clt_tim   | 下发配置清虫时间间隔,单位:分钟                             |
+| location  | 下发手动定位参数:<br> - 参数经纬度值 <br> - `type=1`        |
+| power     | 下发开关机:<br> - 0 关机 <br> - 1 开机                      |
+| clearworm | 下发清虫动作                                                 |
+| reboot    | 重启                                                         |
+| update    | 升级                                                         |  
+
+## 遗愿消息  
+
+设备默认设置配置了 MQTT 遗愿消息。当设备异常下线时(客户端断开前未向服务器发送 DISCONNECT 消息),MQTT 消息服务器会发布异常下线设备的遗愿消息。订阅设备遗愿消息,可实现对设备在线和离线状态的监控。
+
+离线消息主题  
+/yfkj/xycb/offline/imei  
+
+报文结构
+```json
+{
+  "cmd": "offline",
+  "ext": {
+    "imei": "868575028xxxxxx"
+  }
+}
+```