瀏覽代碼

ReadMe.txt加入注释说明command.data的文件格式。

sat23 4 年之前
父節點
當前提交
660722c9bc
共有 1 個文件被更改,包括 18 次插入0 次删除
  1. 18 0
      TCLCommand/TCLCommand/ReadMe.txt

+ 18 - 0
TCLCommand/TCLCommand/ReadMe.txt

@@ -45,4 +45,22 @@ StdAfx.h, StdAfx.cpp
 
 应用程序向导使用“TODO:”注释来指示应添加或自定义的源代码部分。
 
+/////////////////////////////////////////////////////////////////////////////
+Command.data文件格式说明,键值对形式存在[key=value]:
+Key说明:
+name			表示命令名称;
+option			表示命令类型
+				1、Get 表示指令用于查询,不用传入外部数据,需要返回查询结果。
+				2、Set 表示指令用于设置,需要传入外部数据,需要返回设置结果。
+				3、None 表示指令不是查询指令,不用传入外部数据,无查询结果返回;也不是设置指令,不用传入外部数据,无设置结果返回。
+				
+				更确切的说,Get不用传数据,Set要传入数据;
+				Get和Set都要返回除“AB 05 0A DF 4E”外的第二段串口数据(失败除外),而None只返回一段类似“AB 05 0A DF 4E”的数据。
+				
+head			表示命令的协议头,以十六进制字符表示,多个字节以空格隔开;
+cmd				表示命令的具体指令,以十六进制字符表示,只有有且一个字节;
+param			表示命令的具体指令所附加参数,以十六进制字符表示,多个字节以空格隔开;
+returnParam		与param关联使用,表示指令返回结果时,是否会将param一起返回。
+readWaitTime	表示指令在串口Write之后,多久才开始串口Read指令结果
+cmdWaitTime		表示当前指令完成串口Read后,等待多久进行下一条指令操作。
 /////////////////////////////////////////////////////////////////////////////