uartwaitfunc.h

Modbus串口通讯协议通讯源代码

/****************************************************************************
* 文件名：UartWaitFunc.h           (头文件)

* 功能：串口通讯的等待功能函数，用户调用该类函数，可使读写操作命令立即执行，并且

        可立即返回函数执行的结果。

* 说明：
****************************************************************************/
#ifndef UART_WAIT_FUNC_H
#define UART_WAIT_FUNC_H

/*******************************************************************************
函数名: COM_OpenUart
描  述: 打开串口
输  入: port  　   选用的串口，如COM1，COM2等
输  出: 无
返回值: INT32S 类型，其值表示函数的执行结果，为0时则操作成功，否则表示执行的错误
        代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_OpenUart(const INT32S port);
/*******************************************************************************
函数名: COM_CloseUart
描  述: 关闭串口
输  入: port  　   选用的串口，如COM1，COM2等
输  出: 无
返回值: INT32S 类型，其值表示函数的执行结果，为0时则操作成功，否则表示执行的错误
        代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_CloseUart(const INT32S port);
/*******************************************************************************
函数名: COM_SetUartPara
描  述: 设置串口的通讯参数
输  入: port  　   选用的串口，如COM1，COM2等
        baud       选用串口的波特率，应采用动态链接库头文件中给出的数据，如B110，
                   B1200，B9600等
        mode       选用串口的模式，应采用动态链接库头文件中给出的数据，并且将采
                   用的选型进行或操作，如选择模式为数据位8位，停止位1位及无校验
                   位的模式，则mode参数应为"BIT_8|STOP_1|P_NONE"
输  出: 无
返回值: INT32S 类型，其值表示函数的执行结果，为0时则操作成功，否则表示执行的错误
        代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_SetUartPara(const INT32S port, const INT32S baud, const INT32S mode);
/*******************************************************************************
函数名: COM_SetFrameSize
描  述: 设置最大帧长
输  入: port  　   选用的串口，如COM1，COM2等
        MaxSize    最大帧长
输  出: 无
返回值: INT32S 类型，其值表示函数的执行结果，成功返回最大帧长，否则表示执行的错误
        代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_SetFrameSize(const INT32S port, const INT32S MaxSize);
/*******************************************************************************
函数名: COM_SetTimeOut
描  述: 设置最大等待时间
输  入: port  　      选用的串口，如COM1，COM2等
        OutTime       最大等待时间
输  出: 无
返回值: INT32S 类型，其值表示函数的执行结果，成功返回最大等待时间，否则表示执行的错误
        代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_SetTimeOut(const INT32S port, const INT32S OutTime);


/*******************************************************************************
函数名: COM_ReadBitWait
描  述: 读位等待函数，执行该函数后可立即返回执行结果
输  入: byAddr  　    选用的下位机地址，如1，2等
        pabyBitResult 返回读取位或位域的首地址，存放值为16进制格式，如0x01,0x00
        pszDecTag     读取位的信息TAG，如M38.6,详见通讯协议的方式
        dwSize        读取的位的个数
输  出: pabyBitResult 存入读取的结果
返回值: INT32S 类型，其值表示函数的执行结果，为正数时表示读取的位的个数，
        否则表示执行的错误代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_ReadBitWait(INT8U byAddr, INT8U *pabyBitResult, const INT8S *pszDecTag, INT32U dwSize);
/*******************************************************************************
函数名: COM_ReadByteWait
描  述: 读字节等待函数，执行该函数后可立即返回执行结果
输  入: byAddr  　     选用的下位机地址，如1，2等
        pabyByteResult 返回读取字节或字节区间的首地址，以16进制格式存放，如0x1F
        pszDecTag      读取字节的信息TAG，如MB14,详见通讯协议的方式
        dwSize         读取的字节的个数
输  出: pabyByteResult 存入读取的结果
返回值: INT32S 类型，其值表示函数的执行结果，为正数时表示读取的字节的个数，
        否则表示执行的错误代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_ReadByteWait(INT8U byAddr, INT8U *pabyResult, const INT8S *pszDecTag, INT32U dwSize);
/*******************************************************************************
函数名: COM_ReadWordWait
描  述: 读字等待函数，执行该函数后可立即返回执行结果
输  入: byAddr  　     选用的下位机地址，如1，2等
        pawWordResult  返回读取字或字区间的首地址，以16进制存放，如0x131A
        pszDecTag      读取字的信息TAG，如MW22，详见通讯协议的方式
        dwSize         读取的字的个数
输  出: pawResult      存入读取的结果
返回值: INT32S 类型，其值表示函数的执行结果，为正数时表示读取的字的个数，
        否则表示执行的错误代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_ReadWordWait(INT8U byAddr, INT16U *pawResult, const INT8S *pszDecTag, INT32U dwSize);
/*******************************************************************************
函数名: COM_ReadDWordWait
描  述: 读双字等待函数，执行该函数后可立即返回执行结果
输  入: byAddr  　       选用的下位机地址，如1，2等
        padwDWordResult  返回读取字或字区间的首地址，16进制格式存放，如0x1213ABCD
        pszDecTag        读取字的信息TAG，如，MD16,详见通讯协议的方式
        dwSize           读取的字的个数
输  出: padwResult       存入读取的结果
返回值: INT32S 类型，其值表示函数的执行结果，为正数时表示读取的双字的个数，
        否则表示执行的错误代码，详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_ReadDWordWait(INT8U byAddr, INT32U *padwResult, const INT8S *pszDecTag, INT32U dwSize);



/*******************************************************************************
函数名: COM_WriteBitWait
描  述: 写位等待函数，执行该函数后将数据写入指定位地址
输  入: byAddr  　    选用的下位机地址，如1，2等
        pabyBitInput  存放写入数据的首地址，参数以16进制格式输入，如0x00,0x01
        pszDecTag     写位的信息TAG，如M38.5,详见通讯协议的方式
        dwSize        写位的个数
输  出: 无
返回值: 写入正确返回0，否则表示执行的错误代码，
        详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_WriteBitWait(INT8U byAddr, const INT8U *pabyBitInput, const INT8S *pszDecTag, INT32U dwSize);
/*******************************************************************************
函数名: COM_WriteByteWait
描  述: 写字节等待函数，执行该函数后将数据写入指定字节地址
输  入: byAddr  　      选用的下位机地址，如1，2等
        pabyByteInput   存放写入数据的首地址，参数以16进制格式输入，如0x12,0xAB
        pszDecTag       写字节的信息TAG，如MB18,详见通讯协议的方式
        dwSize          写字节的个数
输  出: 无
返回值: 写入正确返回0，否则表示执行的错误代码，
        详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_WriteByteWait(INT8U byAddr, const INT8U *pabyByteInput, const INT8S *pszDecTag, INT32U dwSize);
/*******************************************************************************
函数名: COM_WriteWordWait
描  述: 写字等待函数，执行该函数后将数据写入指定字地址
输  入: byAddr  　      选用的下位机地址，如1，2等
        pawWordInput    存放写入数据的首地址，参数以16进制格式输入，如0x121F
        pszDecTag       写字的信息TAG，如MW12,详见通讯协议的方式
        dwSize          写字的个数
输  出: 无
返回值: 写入正确返回0，否则表示执行的错误代码，
        详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_WriteWordWait(INT8U byAddr, const INT16U *pawWordInput, const INT8S *pszDecTag, INT32U dwSize);
/*******************************************************************************
函数名: COM_DWriteWordWait
描  述: 写双字等待函数，执行该函数后将数据写入指定双字地址
输  入: byAddr  　      选用的下位机地址，如1，2等
        padwDWordInput  存放写入数据的首地址，参数以16进制格式输入，如0x121310AF
        pszDecTag       写双字的信息TAG，如MD18,详见通讯协议的方式
        dwSize          写双字的个数
输  出: 无
返回值: 写入正确返回0，否则表示执行的错误代码，
        详细的错误信息见文件头
*******************************************************************************/
extern INT32S WINAPI COM_WriteDWordWait(INT8U byAddr, const INT32U *padwDWordInput, const INT8S *pszDecTag, INT32U dwSize);

#endif