添加类、函数注释

This commit is contained in:
2024-07-29 14:29:33 +08:00
parent 4b8460f4ce
commit 26f9ff604e
12 changed files with 407 additions and 151 deletions

170
HF15693.h
View File

@@ -76,115 +76,115 @@ extern HF15693_API char t15UID[UID_LEN], t15FirstBN[3], t15NumBl[3], t15Data[DAT
//////////////////////////////
//工具函数
/*********************************************
/* 描述:打开串口
/* 输入:串口号如若打开com1则参数为 1
/* 输出:无
/* 返回:true 打开成功false 打开失败
/* 其他:
/*********************************************/
/*
* 描述:打开串口
* 输入:串口号如若打开com1则参数为 1
* 输出:无
* 返回:true 打开成功false 打开失败
* 其他:
*/
HF15693_API bool t15portOpen(int comno);
/*********************************************
/* 描述:关闭串口
/* 输入:无
/* 输出:无
/* 返回:true 关闭成功false 关闭失败
/* 其他:
/*********************************************/
/*
* 描述:关闭串口
* 输入:无
* 输出:无
* 返回:true 关闭成功false 关闭失败
* 其他:
*/
HF15693_API bool t15portClose();
/*********************************************
/* 描述:设置协议
/* 输入:无
/* 输出:无
/* 返回: 0 设置成功; ~0 设置失败
/* 其他:
/*********************************************/
/*
* 描述:设置协议
* 输入:无
* 输出:无
* 返回: 0 设置成功; ~0 设置失败
* 其他:
*/
HF15693_API int t15setProtocol();
/*********************************************
/* 描述:执行命令
/* 输入:cmdno - 命令字
/* 输出:cmdstr - 向下发出的命令字段reply - 对命令回复的字段
/* 返回:(int) 命令回复字段中的有效字节数
/* 其他:
/*********************************************/
/*
* 描述:执行命令
* 输入:cmdno - 命令字
* 输出:cmdstr - 向下发出的命令字段reply - 对命令回复的字段
* 返回:(int) 命令回复字段中的有效字节数
* 其他:
*/
HF15693_API int t15execute(int cmdno, char *cmdstr,char *reply);
/////////////////////////////////////
/*********************************************
/* 描述:从一个字串中提取一个表示十六进制数字的子串,子串间以',' '[' 分隔
/* 输入: str - 原字串
/* 输出: str - 指向原串中提取到的子串的下一下字符, word - 提取到的子串
/* 返回: 0 - 成功 1 - 失败
/* 其他:
/*********************************************/
/*
* 描述:从一个字串中提取一个表示十六进制数字的子串,子串间以',' '[' 分隔
* 输入: str - 原字串
* 输出: str - 指向原串中提取到的子串的下一下字符, word - 提取到的子串
* 返回: 0 - 成功 1 - 失败
* 其他:
*/
HF15693_API int getXWord (char **str, char *word);
/*********************************************
/* 描述:从一个字串中提取一个表示十六进制数字的子串,子串间以',' '[' 分隔
/* 输入: str - 原字串
/* 输出: word - 提取到的子串
/* 返回:
/* 其他:
/*********************************************/
/*
* 描述:从一个字串中提取一个表示十六进制数字的子串,子串间以',' '[' 分隔
* 输入: str - 原字串
* 输出: word - 提取到的子串
* 返回:
* 其他:
*/
HF15693_API int getXWord2 ( char *str, char *word);
/*********************************************
/* 描述:更改字节序
/* 输入:pin - 原字串 lenbytes - 字串数据长度
/* 输出:pout - 更改字节序后的字串
/* 返回:无
/* 其他:此函数会在pout后补0使用者须保证其长度。
/* 如,字串"123456" 更改字节序后变为 "563412"
/*********************************************/
/*
* 描述:更改字节序
* 输入:pin - 原字串 lenbytes - 字串数据长度
* 输出:pout - 更改字节序后的字串
* 返回:无
* 其他:此函数会在pout后补0使用者须保证其长度。
* 如,字串"123456" 更改字节序后变为 "563412"
*/
HF15693_API void t15changeByteOrder(char *pout,const char *pin,int lenbytes);
/*********************************************
/* 描述:更改带块安全状态信息(block security status)的字串的字节序
/* 输入:pin - 原字串 lenbytes - 字串数据长度,不包含'块安全状态信息'的长度
/* 输出:sbss - 原字串中的bss值 pout - 更改字节序后的字串
/* 返回:无
/* 其他:字串的存储空间由使用者保证会在pout后补0sbss是用字串表示的一个字节的十六进制数
/*********************************************/
/*
* 描述:更改带块安全状态信息(block security status)的字串的字节序
* 输入:pin - 原字串 lenbytes - 字串数据长度,不包含'块安全状态信息'的长度
* 输出:sbss - 原字串中的bss值 pout - 更改字节序后的字串
* 返回:无
* 其他:字串的存储空间由使用者保证会在pout后补0sbss是用字串表示的一个字节的十六进制数
*/
HF15693_API void t15changeByteOrder2(char *sbss,char *pout, char *pin,int lenbytes);
/*********************************************
/* 描述:更改字串的字节序,字串包含多个块的数据
/* 输入:pin - 原字串 numblocks - 原字串中包含的块数目
/* 输出:pout - 更改字节序后的字串
/* 返回:无
/* 其他:每个块数据长度由pin长度和numblocks决定会在pout后补0
/*********************************************/
/*
* 描述:更改字串的字节序,字串包含多个块的数据
* 输入:pin - 原字串 numblocks - 原字串中包含的块数目
* 输出:pout - 更改字节序后的字串
* 返回:无
* 其他:每个块数据长度由pin长度和numblocks决定会在pout后补0
*/
HF15693_API void t15changeByteOrder_MB(char *pout, char *pin, int numblocks);
/*********************************************
/* 描述:更改带块安全状态信息(block security status)的字串的字节序,字串包含多个块的数据
/* 输入:pin - 原字串;lenbytes - 字串数据长度,不包含'块安全状态信息'的长度; numblocks - 原字串中包含的块数目
/* 输出:mbss - 原字串中的bss值 pout - 更改字节序后的字串
/* 返回:无
/* 其他:各个块的bss依次存放于mbss中多个块的数据依次存放于pout中
/*********************************************/
/*
* 描述:更改带块安全状态信息(block security status)的字串的字节序,字串包含多个块的数据
* 输入:pin - 原字串;lenbytes - 字串数据长度,不包含'块安全状态信息'的长度; numblocks - 原字串中包含的块数目
* 输出:mbss - 原字串中的bss值 pout - 更改字节序后的字串
* 返回:无
* 其他:各个块的bss依次存放于mbss中多个块的数据依次存放于pout中
*/
HF15693_API void t15changeByteOrder_MB2(char *mbss,char *pout, char *pin,int lenbytes, int numblocks);
/*********************************************
/* 描述:解析返回的RSSI值
/* 输入:字串表示的RSSI
/* 输出:无
/* 返回:指向解析过的RSSI信息的内存块
/* 其他:返回的指针指向的内存由函数分配管理
/*********************************************/
/*
* 描述:解析返回的RSSI值
* 输入:字串表示的RSSI
* 输出:无
* 返回:指向解析过的RSSI信息的内存块
* 其他:返回的指针指向的内存由函数分配管理
*/
HF15693_API char* t15hex2rssi (char *str);
/*********************************************
/* 描述:解析标签信息字串
/* 输入:data - 原标签信息字串flag - 标签信息标志
/* 输出:(其他参数)
/* 返回:0
/* 其他:
/*********************************************/
/*
* 描述:解析标签信息字串
* 输入:data - 原标签信息字串flag - 标签信息标志
* 输出:(其他参数)
* 返回:0
* 其他:
*/
HF15693_API int t15getTagSysInfo (char *data, const unsigned char flag,char *uid, char *dsfid, char *afi,
char *blSize, char *numBl, char *ic);