增加局域网探测文档

Change-Id: I8bc85a96082f352466ec748c094de0899356735d

Author: archurtan

sdk/video-link-android/doc/局域网探测协议.md

@@ -0,0 +1,76 @@
+## 局域网探测
+
+### 探测流程
+待补充
+
+### 探测消息格式
+|名称   | 位宽  |
+| ------------ | ------------ |
+|固定消息头   | 4Byte  |
+| payload  | 长度不固定  |
+
+注：探测消息的最大长度不能超过1000Byte;
+
+### 消息头
+|  含义 | 取值  | 位宽  |
+| ------------ | ------------ | ------------ |
+| type  | 1：探测消息；2：探测响应消息；其他保留  | 8bit  |
+| 版本号 | 高4bit：主版本号；低4bit：子版本号 | 8bit  |
+| 长度   | payload长度，不包含消息头| 16bit|
+
+**注意**
+网络上传输采用大端字节序，消息头的发送顺序如下：
+
+| 第0Byte  |  第1Byte |  第2Byte | 第3Byte  |
+| ------------ | ------------ | ------------ | ------------ |
+| type  |  版本号 | 长度低8位  |  长度高8位  |
+
+
+### payload探测消息格式
+```
+{
+    "method": "probe",
+    "clientToken": "xxxx-xxxx-xxxx-xxxx-xxxxxxxx",
+    "timestamp": 1606963491,
+    "timeoutMs": 5000,
+    "params": {
+        "productId": "XXXXXXX",
+        "deviceName": "dev_1,dev_2 ..."
+    }
+}
+```
+参数说明：
+method:消息类型
+clientToken：消息标识
+timestamp：消息发送的时间
+timeoutMs：消息超时时间
+productId：搜索设备的产品ID，用于区分不同厂商的设备，可以设置为三元组的ProductId，也可以由用户自定义设置；
+deviceName：搜索设备的名称，如有多个设备则用','隔开；如果没有该字段标表示搜索当前产品下的所有设备，该字段只需要保证唯一性即可，不一定必须使用三元组信息中的deviceName；
+
+其中，productId和deviceName只能由数字，字母和下划线组成；
+
+
+### payload响应消息格式
+```
+{
+    "method": "probeMatch",
+    "clientToken": "xxxx-xxxx-xxxx-xxxx-xxxxxxxx",
+    "timestamp": 1606963492,
+    "params": {
+        "deviceName": "dev_1"
+        "address": "xxx.xxx.x.x",
+        "port": xx
+    },
+    "code": 0,
+    "status": ""
+}
+```
+参数说明：
+method:消息类型
+clientToken：消息标识，与发送消息一致
+timestamp：消息发送的时间
+deviceName：设备的名称
+address：设备的IP地址
+port：设备的端口号
+code: 状态码，一般是0
+status:扩展使用