SerialPort.h File Reference

#include <stdint.h>
#include "hal/Types.h"

Go to the source code of this file.

Enumerations
enum	HAL_SerialPort : int32_t { HAL_SerialPort_Onboard = 0 , HAL_SerialPort_MXP = 1 , HAL_SerialPort_USB1 = 2 , HAL_SerialPort_USB2 = 3 }

Functions
HAL_SerialPortHandle	HAL_InitializeSerialPort (HAL_SerialPort port, int32_t *status)
	Initializes a serial port. More...
HAL_SerialPortHandle	HAL_InitializeSerialPortDirect (HAL_SerialPort port, const char *portName, int32_t *status)
	Initializes a serial port with a direct name. More...
int	HAL_GetSerialFD (HAL_SerialPortHandle handle, int32_t *status)
	Gets the raw serial port file descriptor from a handle. More...
void	HAL_SetSerialBaudRate (HAL_SerialPortHandle handle, int32_t baud, int32_t *status)
	Sets the baud rate of a serial port. More...
void	HAL_SetSerialDataBits (HAL_SerialPortHandle handle, int32_t bits, int32_t *status)
	Sets the number of data bits on a serial port. More...
void	HAL_SetSerialParity (HAL_SerialPortHandle handle, int32_t parity, int32_t *status)
	Sets the number of parity bits on a serial port. More...
void	HAL_SetSerialStopBits (HAL_SerialPortHandle handle, int32_t stopBits, int32_t *status)
	Sets the number of stop bits on a serial port. More...
void	HAL_SetSerialWriteMode (HAL_SerialPortHandle handle, int32_t mode, int32_t *status)
	Sets the write mode on a serial port. More...
void	HAL_SetSerialFlowControl (HAL_SerialPortHandle handle, int32_t flow, int32_t *status)
	Sets the flow control mode of a serial port. More...
void	HAL_SetSerialTimeout (HAL_SerialPortHandle handle, double timeout, int32_t *status)
	Sets the minimum serial read timeout of a port. More...
void	HAL_EnableSerialTermination (HAL_SerialPortHandle handle, char terminator, int32_t *status)
	Sets the termination character that terminates a read. More...
void	HAL_DisableSerialTermination (HAL_SerialPortHandle handle, int32_t *status)
	Disables a termination character for reads. More...
void	HAL_SetSerialReadBufferSize (HAL_SerialPortHandle handle, int32_t size, int32_t *status)
	Sets the size of the read buffer. More...
void	HAL_SetSerialWriteBufferSize (HAL_SerialPortHandle handle, int32_t size, int32_t *status)
	Sets the size of the write buffer. More...
int32_t	HAL_GetSerialBytesReceived (HAL_SerialPortHandle handle, int32_t *status)
	Gets the number of bytes currently in the read buffer. More...
int32_t	HAL_ReadSerial (HAL_SerialPortHandle handle, char *buffer, int32_t count, int32_t *status)
	Reads data from the serial port. More...
int32_t	HAL_WriteSerial (HAL_SerialPortHandle handle, const char *buffer, int32_t count, int32_t *status)
	Writes data to the serial port. More...
void	HAL_FlushSerial (HAL_SerialPortHandle handle, int32_t *status)
	Flushes the serial write buffer out to the port. More...
void	HAL_ClearSerial (HAL_SerialPortHandle handle, int32_t *status)
	Clears the receive buffer of the serial port. More...
void	HAL_CloseSerial (HAL_SerialPortHandle handle, int32_t *status)
	Closes a serial port. More...