Browse Source

Merge branch 'main' of http://code.nyzhwlw.com:3000/yf_yzl/yfdoc

林轩 11 months atrás
parent
commit
e5463b4a46
3 changed files with 136 additions and 18 deletions
  1. 7 11
      zh-cn/cbd.md
  2. 116 1
      zh-cn/scd.md
  3. 13 6
      zh-cn/xct.md

+ 7 - 11
zh-cn/cbd.md

@@ -171,17 +171,13 @@
 }
 ```
 ## 参数说明
-接口地址
-http://xxxxxxxxxx/xxxxx
 
-接口方式
-Post
 
-参数说明
-
-| 属性字段       | 含义或表示的内容                                                                 |
-| -------------- | ------------------------------------------------------------------------------ |
-| imei           | 设备序列号                                                                     |
-| Image          | 拍照图片(图片链接,建议下载保存到本地)                                       |
-| Result_image   | 识别结果图片(图片链接,建议下载保存到本地)                                   |
+| 字段名       | 描述                                                                 |
+| ------------ | -------------------------------------------------------------------- |
+|接口地址       |http://xxxxxxxxxx/xxxxx                                               |
+|接口方式       |Post                                                                  |
+| imei           | 设备序列号                                                          |
+| Image          | 拍照图片(图片链接,建议下载保存到本地)                              |
+| Result_image   | 识别结果图片(图片链接,建议下载保存到本地)                           |
 | Result         | 昆虫种类及数目(如模型未识别到害虫,`Result_image` 与 `Result` 数据为 0)     |

+ 116 - 1
zh-cn/scd.md

@@ -1 +1,116 @@
-# 杀虫灯
+# 物联网杀虫灯与服务器端交互通讯细节
+
+## 简述
+
+本文档主要用于阐述物联网杀虫灯与服务器端进行交互的通讯细节。
+
+## 通信描述
+
+对接采用 HTTP 协议,由接收方写接口来接收 http post 数据(需从 request 的 body (字节流类型)中取数据,取到之后进行 json 解析)。
+
+## 对接说明
+
+### 设备数据说明
+
+1. **数据上传时间默认为 30 分钟一次**。
+2. **电击次数就是杀虫数**,上传一次 data 数据后重置为 0。
+
+### 设备对接说明
+
+1. **设备数据包含**:设备号、SIM 卡号、境温湿度、工作状态、经纬度、电压等。
+2. **由接收方提供接口接收数据**,设备方推送数据,需要提供一个可以外网访问的接口接收数据(与接收数据(离线数据与 data 数据区分,根据数据中的 cmd 字段进行区分))。
+3. **先进行接口测试**,没问题后才能发正式数据。
+4. **如果对接完成后设备未收到数据**,请先检查所提供的接口是否有问题,然后再联系对接人员。
+5. **设备上线后会自动发送 data 数据**。
+6. **关于接口安全问题**,可以针对传输方 IP 做限制,不是传输方的 IP 不让其调用接口,(传输方 IP 可以联系对接人员提供)。
+7. **设备数据格式不可变**,不能按接收方增加或者减少字段,如有需求请联系销售经理。
+8. **接口设置是我们这边进行配置**,您只需要把接口发给对接人员就可以了。
+
+## 设备数据报文结构
+
+```json
+{
+  "topic": "/yfkj/scd/pub/867435052203452",
+  "payload": {
+    "cmd": "data",
+    "ext": {
+      "imei": "867435052203452",
+      "iccid": "89680401101700076471",
+      "csq": "29",
+      "dtype": "1",
+      "dver": "1.0.0",
+      "stm8vs": "1.0.0",
+      "ws": "0",
+      "ds": "1",
+      "tt": "7",
+      "lps": "0",
+      "rps": "0",
+      "tps": "0",
+      "dps": "0",
+      "bt": "25",
+      "voltval": "60",
+      "ts": "0",
+      "st": "20",
+      "et": "2",
+      "cv": "18.000",
+      "bv": "12.800",
+      "at": "0",
+      "ah": "0",
+      "ct": "0",
+      "clt_t": "30",
+      "dat_f": "30",
+      "rcnt": "0",
+      "info": "2",
+      "gps": "1",
+      "lng": "113.67336",
+      "lat": "34.815187",
+      "stamp": "20180301211805"
+    }
+  }
+}
+```
+字段说明
+
+| 字段名       | 描述                                                                 |
+| ------------ | -------------------------------------------------------------------- |
+| imei         | 通讯板唯一 ID                                                       |
+| iccid        | SIM 卡卡号                                                           |
+| csq          | 信号强度                                                             |
+| dver         | 4G 物联网模块代码版本号                                             |
+| ws           | 工作状态 0: 待机,1: 工作,2: 充电                                   |
+| ds           | 设备开关 0: 关机,1: 开机                                            |
+| tt           | 定时时长 (0~7)小时, 0 表示常亮                                       |
+| lps          | 光控状态 0: 正常 1: 保护 (检测到白天,光控模式下白天不工作,所以保护,2: 充电状态) |
+| rps          | 雨控状态 0: 正常 1: 保护                                             |
+| tps          | 温控状态 0: 正常 1: 保护 (设备进入温控状态)                          |
+| dps          | 倾倒状态 0: 正常 1: 保护 (设备进入倾倒状态)                          |
+| bt           | 主板温度,默认 25 度                                                 |
+| ts           | 时控开关 0: 关闭时控 1: 开启时控(设备工作状态,光控默认工作时间为天黑后 8 小时,时控可以设置工作时间范围) |
+| st           | 时控开始时间,单位: 小时 0~23                                        |
+| et           | 时控结束时间,单位: 小时 0~23                                        |
+| cv           | 充电电压,单位: V 字符串                                             |
+| bv           | 电池电压,单位: V 字符串                                             |
+| at           | 环境温度 (字符串)                                                    |
+| ah           | 环境湿度 (字符串)                                                    |
+| ct           | 电击次数,范围 0~255 (每上报一次数据消息(data 消息)后清零)         |
+| clt_t        | 清虫间隔时间,单位:分钟                                             |
+| dat_f        | 数据上传时间,单位:分钟                                             |
+| rcnt         | 设备重启次数                                                         |
+| gps          | 定位方式 0: 手动定位 1: GPS 定位 2: 基站定位                         |
+| lng          | 经度                                                                 |
+| lat          | 纬度                                                                 |
+| stamp        | 时间戳,格式:YYYYMMDDHHmmss(例如 20180301211805)                 |
+
+遗愿消息
+设备默认设置配置了 MQTT 遗愿消息。当设备异常下线时(客户端断开前未向服务器发送 DISCONNECT 消息),MQTT 消息服务器会发布异常下线设备的遗愿消息。
+
+报文结构
+```
+{
+  "cmd": "offline",
+  "ext": {
+    "imei": "867435052203452"
+  },
+  "topic": "/yfkj/scd/pub/867435052203452"
+}
+```

+ 13 - 6
zh-cn/xct.md

@@ -64,10 +64,11 @@
     }
   }
 }
+```
 字段说明
 
 | 字段名       | 描述                                                                 |
-| ------------ | -------------------------------------------------------------------- |
+| ------       | -------------------------------------------------------------------- |
 | imei         | 通讯板唯一 ID                                                       |
 | iccid        | 物联网卡的 iccid 号,用于查询物联网卡的套餐、流量信息等               |
 | csq          | 信号强度                                                             |
@@ -90,8 +91,11 @@
 | shake_sec    | 震动时间:1~20(步长:100ms)                                         |
 | fuse_voltage | 保险丝电压                                                           |
 | ds           | 设备开关状态 0: 关机 1: 开机                                          |
+
 设备下线消息
 设备默认配置了遗愿消息,当设备异常下线时(客户端断开前未向服务器发送 DISCONNECT 消息),会发布异常下线设备的遗愿消息。
+
+```
 {
   "payload": {
     "cmd": "offline",
@@ -101,6 +105,7 @@
   },
   "topic": "/yfkj/cbd/pub/868575028xxxxxx"
 }
+```
 注意:设备离线会发送一条设备下线消息,设备上线后发送正常数据。
 
 图片传输
@@ -108,16 +113,18 @@
 由接收方写接口来接收 http post 数据(需从 request 的 body(字节流类型)中取数据,取到之后进行 json 解析)。图片需要下载保存到本地,不要直接保存图片链接到数据库。
 
 不带害虫识别图片传输案例
+```
 {
   "Image": "http://www.yfzhwlw.com/pyftp/ftp_file/ykm_cbd/868956048817419/192.168.1.100_01_20200623233048184_ALARM_INPUT.jpg",
   "imei": "868575028xxxxxx"
 }
+```
+
 参数说明
-接口地址:http://xxxxxxxxxx/xxxxx
-接口方式:Post
-参数说明:
 
 | 字段名       | 描述                                                                 |
 | ------------ | -------------------------------------------------------------------- |
-| imei         | 设备序列号                                                           |
-| Image        | 拍照图片(图片链接,建议下载保存)                                   |
+|接口地址       |http://xxxxxxxxxx/xxxxx                                               |
+|接口方式       |Post                                                                  |
+| imei         | 设备序列号                                                            |
+| Image        | 拍照图片(图片链接,建议下载保存)                                      |