serialport.h File Reference

Go to the source code of this file.

Data Structures
struct	s_SERIALPORT_STRUCT
	Serial Port structure. More...

Typedefs
typedef struct s_SERIALPORT_STRUCT	serialport_t
	Serial Port structure. More...

Functions
serialport_t *	serialport_open (const char *name)
int	serialport_close (serialport_t *sps)
int	serialport_config (serialport_t *sps, unsigned int baud)
int	serialport_write (serialport_t *sps, unsigned char *data, unsigned int bytes)
int	serialport_byte (serialport_t *sps, unsigned char byte)
int	serialport_flush_input (serialport_t *sps)

Detailed Description

Author

Eriks Zaharans

Date

1 Jul 2013

DESCRIPTION

Serial Port library header file.

Definition in file serialport.h.

Typedef Documentation

typedef struct s_SERIALPORT_STRUCT serialport_t

Serial Port structure.

Function Documentation

int serialport_byte	(	serialport_t *	sps,
		unsigned char	byte
	)

Write byte to serial port

Parameters

sps	Pointer to serial port structure
byte	Byte to be written

Returns

The number of bytes written, otherwise s_ERROR

Definition at line 178 of file serialport.c.

int serialport_close

(

serialport_t *

sps

)

Close serial port

Parameters

sps	Pointer to serial port structure

Returns

s_OK if successful, s_ERROR if failed

Definition at line 58 of file serialport.c.

int serialport_config	(	serialport_t *	sps,
		unsigned int	baud
	)

Configure serial port

Parameters

sps	Pointer to serial port structure
baud	Baudrate of serial port communication

Returns

s_OK if successful, s_ERROR if failed

Definition at line 82 of file serialport.c.

int serialport_flush_input

(

serialport_t *

sps

)

Flush input buffer

Parameters

sps	Pointer to serial port structure

Returns

number of flushed bytes, otherwise s_ERROR

Definition at line 189 of file serialport.c.

serialport_t* serialport_open

(

const char *

name

)

Open serial port

Parameters

name	Serial port name ("/dev/tty...")

Returns

Pointer to serial port structure

Definition at line 33 of file serialport.c.

int serialport_write	(	serialport_t *	sps,
		unsigned char *	data,
		unsigned int	bytes
	)

Write data to serial port

Parameters

sps	Pointer to serial port structure
data	Data to be written
bytes	Number of bytes to be written

Returns

The number of bytes written, otherwise s_ERROR

Definition at line 166 of file serialport.c.