lib_uart.h 文件参考

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

宏定义
#define	ERROR_NOSUPPORT   -5
	函数失败返回值,不支持对应设备返回值 更多...
#define	ERROR_SYS   -4
	函数失败返回值,系统错误返回值 更多...
#define	ERROR_INPARA   -3
	函数失败返回值,段错误返回值 更多...
#define	ERROR_TIMEOUT   -2
	函数失败返回值,超时返回值 更多...
#define	ERROR_FAIL   -1
	函数失败返回值,写入错误返回值 更多...
#define	ERROR_OK   0
	函数失败返回值,正常结束返回值 更多...
#define	UART_API

函数
UART_API int	uart_init (char *dev, int nBaud, int nBits, char nEvent, int nStop)
	初始化串口 更多...
UART_API int	uart_write_data (int fd, char *buff, int len)
	向串口写数据 更多...
UART_API int	uart_read_data (int fd, char *buff, int len, int timeout_ms)
	读取串口信息 更多...
UART_API void	uart_close (int fd)
	关闭串口 更多...
UART_API int	uart_open (char *dev_name)
	打开串口 更多...
UART_API int	uart_write (int fd, char *buff, int len)
	向串口写数据,，参数和使用方法与 uart_write_data 函数一样 更多...
UART_API int	uart_read (int fd, char *buff, int len)
	读取串口信息，默认读取超时时间为1秒 更多...
UART_API int	receive_uart (char *dev_name, char *buff, int len, int timeout_ms, int rx_time_ms)

详细描述

日期

2024-12-09

版权所有

Copyright (c) 2024

在文件 lib_uart.h 中定义.

宏定义说明

#define ERROR_FAIL   -1

函数失败返回值,写入错误返回值

在文件 lib_uart.h 第 16 行定义.

#define ERROR_INPARA   -3

函数失败返回值,段错误返回值

在文件 lib_uart.h 第 14 行定义.

#define ERROR_NOSUPPORT   -5

函数失败返回值,不支持对应设备返回值

在文件 lib_uart.h 第 12 行定义.

#define ERROR_OK   0

函数失败返回值,正常结束返回值

在文件 lib_uart.h 第 17 行定义.

#define ERROR_SYS   -4

函数失败返回值,系统错误返回值

在文件 lib_uart.h 第 13 行定义.

#define ERROR_TIMEOUT   -2

函数失败返回值,超时返回值

在文件 lib_uart.h 第 15 行定义.

#define UART_API

在文件 lib_uart.h 第 22 行定义.

函数说明

UART_API int receive_uart	(	char *	dev_name,
		char *	buff,
		int	len,
		int	timeout_ms,
		int	rx_time_ms
	)

UART_API void uart_close

(

int

fd

)

关闭串口

参数

fd	要关闭串口文件描述符

UART_API int uart_init	(	char *	dev,
		int	nBaud,
		int	nBits,
		char	nEvent,
		int	nStop
	)

初始化串口

参数

dev	串口名,如"/dev/ttySAC3"
nBaud	波特率，可取值:9600 115200等
nBits	数据位数 7 或者 8
nEvent	‘O’ 奇校验； ‘E’ 偶校验； ‘N’ 无校验
nStop	停止位数 1 或者

返回

int 初始化成功返回0,失败返回-1

UART_API int uart_open

(

char *

dev_name

)

打开串口

参数

dev_name

串口名,如"/dev/ttySAC3"

返回

int 打开成功返回串口文件描述符，失败返回-5

UART_API int uart_read	(	int	fd,
		char *	buff,
		int	len
	)

读取串口信息，默认读取超时时间为1秒

参数

fd	串口文件描述符
buff	存放要读取的内容
len	内容大小

返回

int 成功返回读取的大小，读取失败返回-1,读取超时返回-2,读取的串口不存在返回-5

UART_API int uart_read_data	(	int	fd,
		char *	buff,
		int	len,
		int	timeout_ms
	)

读取串口信息

参数

fd	串口文件描述符
buff	存放要读取的内容
len	内容大小
timeout_ms	设置超时时间,/ms

返回

int 成功返回读取的大小，读取失败返回-1,读取超时返回-2,读取的串口不存在返回-5

UART_API int uart_write	(	int	fd,
		char *	buff,
		int	len
	)

向串口写数据,，参数和使用方法与 uart_write_data 函数一样

参数

fd	串口文件描述符
buff	存放要写入的内容
len	内容大小

返回

int 成功返回写入的大小，写入失败返回-1，写入的串口不存在返回-5

UART_API int uart_write_data	(	int	fd,
		char *	buff,
		int	len
	)

向串口写数据

参数

fd	串口文件描述符
buff	存放要写入的内容
len	内容大小

返回

int 成功返回写入的大小，写入失败返回-1，写入的串口不存在返回-5