diff --git a/img/image3.png b/img/image3.png index a71b573..dd58e3d 100644 --- a/img/image3.png +++ b/img/image3.png diff --git a/通讯协议-SDK应用部分.md b/通讯协议-SDK应用部分.md index d8c41f9..42acb16 100644 --- a/通讯协议-SDK应用部分.md +++ b/通讯协议-SDK应用部分.md @@ -68,7 +68,16 @@ WSCmdApp程序中config.ini配置文件中可设置WebSocket的端口，见以 ![](img/image3.png) -上述配置#号开头行，为注释行，对下面一个配置进行说明。每个配置参考上面说明。 +config.ini 文件关键字解释说明： +role： WSCmdApp当前WebSocket运行模式；client：客户端模式，server：服务端模式。 +ip: 需要访问的WebSocket服务器的ip地址，此参数在客户端模式下有效 +port: WebSocket通讯的端口地址 +heartBeatOnOf:心跳判定开关，此参数配合协议文档中的“心跳”指令使用。 +当参数配置为0: WSCmdApp会配合的回复对应参数，不进入心跳检测程序， +当参数配置为1: WSCmdApp会配合的回复对应参数，进入心跳检测程序。 +heartbeat: 心跳间隔时长 范围：10-60 单位秒 +当heartBeatOnOff配置为1，并且WebSocket运行模式为客户端时，进入心跳检测程序后，在单位时间没有收到心跳指令，WebSocket客户端会重启，重新连接服务器。 + # 设计目的 @@ -123,22 +132,19 @@ X\~Y:范围内的值特指整数。 # 通信方式 数据交互采取发送<-->应答的方式。应用程序发送数据到WSCmdApp，WSCmdApp收到后执行完成后回复。 -应用程序没有数据发送给WSCmdApp时，需要发送心跳，WSCmdApp收到心跳后会回复心跳，用于判断与应用程序的连接状态。（配置文件中，如果启用了心跳检查，应用程序如果未按要求发送心跳，WSCmdApp会断开当前连接，重新尝试连接） +应用程序没有数据发送给WSCmdApp时，可通过向WSCmdApp发送心跳指令。 + +WSCmdApp端被设置为Websocket 服务端模式时，应用程序可通过WSCmdApp回复的心跳来确认与WSCmdApp的连接状态。 + +WSCmdApp端被设置为Websocket 客户端模式时， WSCmdApp将自动根据心跳判定开关及心跳参数的设置内容进行重连的自动判断。 + + # 编程流程说明 用户使用WSCmdApp编程的基本流程如下： 配置参数：(可配置、详情见配置文件config.ini) -1、sdk->role websocket -的运行模式【client:客户端模式，server：服务端模式】 。 - -2、sdk-> ip 如果websocket处于客户端模式 -此ip为目标服务器ip；如果websocket处于服务端模式 此ip无效。 - -3、sdk-> port如果websocket处于客户端模式 -此port为目标服务器port；如果websocket处于服务端模式 -此port为本服务端port。 编程开发： 1、使用websocket通讯，IP为IP地址 @@ -5372,6 +5378,8 @@ infos:{ "funId":"F0001","code":"10002"}// |20004|参数错误| |20005|基站繁忙| |30001|找不到对应的SN| +|30002|找不到对应的BaseID| +|30003|基站SN不是对应的BaseID| |40001|升级功能只能支持一个基站在线| |50001|此功能必须指定基站ID| |60001|此功能必须指定键盘SN| diff --git a/通讯协议-SDK应用部分[内部].md b/通讯协议-SDK应用部分[内部].md index 1f2f417..9548f2b 100644 --- a/通讯协议-SDK应用部分[内部].md +++ b/通讯协议-SDK应用部分[内部].md @@ -68,7 +68,16 @@ WSCmdApp程序中config.ini配置文件中可设置WebSocket的端口，见以 ![](img/image3.png) -上述配置#号开头行，为注释行，对下面一个配置进行说明。每个配置参考上面说明。 +config.ini 文件关键字解释说明： +role： WSCmdApp当前WebSocket运行模式；client：客户端模式，server：服务端模式。 +ip: 需要访问的WebSocket服务器的ip地址，此参数在客户端模式下有效 +port: WebSocket通讯的端口地址 +heartBeatOnOf:心跳判定开关，此参数配合协议文档中的“心跳”指令使用。 +当参数配置为0: WSCmdApp会配合的回复对应参数，不进入心跳检测程序， +当参数配置为1: WSCmdApp会配合的回复对应参数，进入心跳检测程序。 +heartbeat: 心跳间隔时长 范围：10-60 单位秒 +当heartBeatOnOff配置为1，并且WebSocket运行模式为客户端时，进入心跳检测程序后，在单位时间没有收到心跳指令，WebSocket客户端会重启，重新连接服务器。 + # 设计目的 @@ -123,22 +132,19 @@ X\~Y:范围内的值特指整数。 # 通信方式 数据交互采取发送<-->应答的方式。应用程序发送数据到WSCmdApp，WSCmdApp收到后执行完成后回复。 -应用程序没有数据发送给WSCmdApp时，需要发送心跳，WSCmdApp收到心跳后会回复心跳，用于判断与应用程序的连接状态。（配置文件中，如果启用了心跳检查，应用程序如果未按要求发送心跳，WSCmdApp会断开当前连接，重新尝试连接） +应用程序没有数据发送给WSCmdApp时，可通过向WSCmdApp发送心跳指令。 + +WSCmdApp端被设置为Websocket 服务端模式时，应用程序可通过WSCmdApp回复的心跳来确认与WSCmdApp的连接状态。 + +WSCmdApp端被设置为Websocket 客户端模式时， WSCmdApp将自动根据心跳判定开关及心跳参数的设置内容进行重连的自动判断。 + + # 编程流程说明 用户使用WSCmdApp编程的基本流程如下： 配置参数：(可配置、详情见配置文件config.ini) -1、sdk->role websocket -的运行模式【client:客户端模式，server：服务端模式】 。 - -2、sdk-> ip 如果websocket处于客户端模式 -此ip为目标服务器ip；如果websocket处于服务端模式 此ip无效。 - -3、sdk-> port如果websocket处于客户端模式 -此port为目标服务器port；如果websocket处于服务端模式 -此port为本服务端port。 编程开发： 1、使用websocket通讯，IP为IP地址 @@ -6494,6 +6500,8 @@ infos:{ "funId":"F0001","code":"10002"}// |20004|参数错误| |20005|基站繁忙| |30001|找不到对应的SN| +|30002|找不到对应的BaseID| +|30003|基站SN不是对应的BaseID| |40001|升级功能只能支持一个基站在线| |50001|此功能必须指定基站ID| |60001|此功能必须指定键盘SN|