更新 README(zh-cn).md

Author: NEVSTOP

README(zh-cn).md

@@ -12,8 +12,51 @@
 - 基于JKI-TCP-Server库，支持多个TCP客户端同时连接。
 - [client] 提供一个标准的TCP客户端，可以连接到服务器，验证远程连接、消息发送等功能。
 
-> [!IMPORTANT]
-> `TCP数据包格式：` | 数据长度(4字节) | CSM命令字符串(纯文本) |
+## 通讯协议
+
+CSM-TCP-Router 中 TCP 数据包格式定义如下：
+
+>
+> | `数据长度(4字节)` | `数据包类型(10字节)` | `数据内容` |
+>
+
+### 数据长度
+
+数据长度为4字节，表示整个 tcp 数据包的长度，包括数据包类型和数据包内容。
+
+### 数据包类型
+
+数据包类型用于描述数据包的内容，长度为10字节，不足10字节的用 `\0` 填充。
+
+数据包类型相当于一个枚举类型，目前支持的数据包类型有：
+
+- 信息数据包(info)
+- 错误数据包(error)
+- 指令数据包(cmd)
+- 同步响应数据包(resp)
+- 异步响应数据包(async-resp)
+- 订阅返回数据包(status)
+
+### 数据内容
+
+#### 信息数据包(info)
+
+info 数据包的数据内容为提示信息内容，纯文本格式。
+
+#### 错误数据包(error)
+
+error 数据包的数据内容为错误信息内容，为纯文本格式，文本格式定为 CSM Error 格式。
+
+> [!NOTE]
+> CSM Error 格式为："[Error: `错误代码`]`错误字符串`"。
+
+#### 参数/返回数据格式描述
+
+同步(-@)、异步(->)、无返回异步(->|)消息都可能携带参数，`status` 数据包也会携带状态参数。
+
+#### 指令数据包(cmd)
+
+指令数据包的数据内容为指令内容，格式为 CSM 本地指令格式，支持同步(-@)、异步(->)、无返回异步(->|)消息，注册(register)、注销(unregister)。 参数格式见 [参数/返回数据包](#参数返回数据格式描述)
 
 > [!NOTE]
 > 举例：假设本地程序存在名为DAQmx的CSM模块，具有一个接口为 "API: Start Sampling".
@@ -23,12 +66,45 @@
 > - API: Start Sampling -> DAQmx // 异步消息
 > - API: Start Sampling ->| DAQmx // 异步无返回消息
 >
-> 现在只要通过TCP连接，发送同样的文本消息，就可以实现远程控制。
+> 现在只要通过TCP连接，发送同样的文本消息，就可以实现远程消息。
+>
+
+> [!NOTE]
+> 举例：假设本地程序存在名为A的CSM模块，不停的发送一个监控状态为 "Status", 另外一个模块B可以订阅这个状态。
+>
+> - status@a >> api@b -><register> // 订阅状态
+> - status@a >> api@b -><unregister> // 取消订阅
+>
+> 现在只要通过TCP连接，发送同样的文本消息，就可以实现远程控制底层 csm 模块的订阅
+>
+> 但是如果发送中缺省了订阅方(api@b), 则表示连接到 tcp-router 的 client订阅状态
+>
+> - status@a -><register> // client 订阅 A 模块status
+> - status@a >> api@b -><unregister> // 取消 client 订阅 A 模块status
+>
+> 当 A 模块发出 Status 后，client 将自动收到 `status` 数据包
+>
+
+#### 同步响应数据包(resp)
+
+当执行完毕同步消息指令后，tcp-router 将 response 返回给 client.
+
+- `Response数据` 格式见 [参数/返回数据包](#参数返回数据格式描述)
+
+#### 异步响应数据包(async-resp)
+
+当执行完毕同步消息指令后，tcp-router 将 response 返回给 client. 格式为："`Response数据` <- `异步消息原文`"
+
+- `Response数据` 格式见 [参数/返回数据包](#参数返回数据格式描述)
+- `异步消息原文` 异步消息原文
+
+#### 订阅返回数据包(status)
+
+Client 订阅了CSM模块的状态，当状态发生时，client 会自动收到此数据包。
 
-> [!WARNING]
-> 目前CSM-TCP-Router只支持同步消息(-@)和无返回的异步消息(->|)，异步消息(->)将被视为无返回的异步消息。
+数据包格式为 "状态名 >> `状态数据` <- 发送模块"。`状态数据`格式见 [参数/返回数据包](#参数返回数据格式描述)
 
-## 支持的指令集
+## 指令集
 
 ![image](.doc/CSM-TCP-Router.drawio.png)
 

src/CSM-TCP-Router.lvcsm

@@ -125,8 +125,8 @@ Item 27 = "action: loop check"
 Item 28 = "action: end loop"
 
 [CSM Debug Console]
-Response Timeout(s) = 30
-History Length = 50
+Response Timeout(s) = 30    
+History Length = 50    
 
 [CSMModule.CSM TCP Router]
 VIName = "CSM-TCP-Router.lvlib:CSM-TCP-Router.vi"
@@ -213,4 +213,7 @@ doc = "AI Module with 4 Channels.%0AAPI:%0A1. Channels %2F%2F List all Channels
 doc = "DIO Module with 8 Channels.%0AAPI:%0A1. TurnOn %3E%3E ChannelIndex %2F%2FSet Channel to ON.%0A2. TurnOff %3E%3E ChannelIndex %2F%2FSet Channel to OFF.%0A3. Check %3E%3E ChannelIndex %2F%2FCheck current status of Channel.%0A4. CheckAll %2F%2FCheck status of all channels%0A5. ResetAll %2F%2FReset All channels"
 
 [CSMDoc.MAL-TEST.vi]
-doc = "Measurement Module.%0AAPI: %0A1. Sweep %3E%3E Start%3BStop%3BStep%3BInterval %2F%2F sweep current with specified parameters.%0A2. Measure %2F%2F Return voltage and current at the same time."
+doc = "Measurement Module.%0AAPI: %0A1. Sweep %3E%3E Start%3BStop%3BStep%3BInterval %2F%2F sweep current with specified parameters.%0A2. Measure %2F%2F Return voltage and current at the same time."
+
+[CSMModule.Measure2]
+VIName = "MAL-TEST.vi"

src/Client/Client.vi

@@ -5,11 +5,11 @@
 	<Property Name="NI.Lib.Version" Type="Str">1.0.0.0</Property>
 	<Item Name="Support" Type="Folder">
 		<Item Name="Connection Handler Worker.vi" Type="VI" URL="../_support/Connection Handler Worker.vi"/>
+		<Item Name="pack tcp packet.vi" Type="VI" URL="../_support/pack tcp packet.vi"/>
+		<Item Name="unpack tcp packet.vi" Type="VI" URL="../_support/unpack tcp packet.vi"/>
 	</Item>
 	<Item Name="Typedef" Type="Folder">
 		<Item Name="tcp-msg type.ctl" Type="VI" URL="../typedef/tcp-msg type.ctl"/>
 	</Item>
 	<Item Name="CSM-TCP-Router.vi" Type="VI" URL="../CSM-TCP-Router.vi"/>
-	<Item Name="Pack.vi" Type="VI" URL="../_support/Pack.vi"/>
-	<Item Name="unpack.vi" Type="VI" URL="../_support/unpack.vi"/>
 </Library>