inc/flexSerial.h File Reference

Serial communication. More...

#include <windows.h>

Go to the source code of this file.

Data Structures

struct  Flex_Serial
 The serial object data type. More...

Functions

int flex_Serial_init (Flex_Serial *com, const char *port_name, unsigned int baud_rate)
 Open the serial port.
void flex_Serial_close (Flex_Serial *com)
 Close the serial port.
int flex_Serial_getc (Flex_Serial *com, char *data)
 Read one byte from the serial.
int flex_Serial_putc (Flex_Serial *com, char data)
 Write one byte to the serial.
int flex_Serial_read (Flex_Serial *com, char *data, unsigned int data_size)
 Read data_size bytes from the serial.
int flex_Serial_write (Flex_Serial *com, char *data, unsigned int data_size)
 Write data_size bytes to the serial.


Detailed Description

Serial communication.

Author:
Nastasi Christian
Date:
2007-12-17

Function Documentation

void flex_Serial_close ( Flex_Serial com  ) 

Close the serial port.

Parameters:
com The Serial Object to close

int flex_Serial_getc ( Flex_Serial com,
char *  data 
)

Read one byte from the serial.

Parameters:
com The serial object
data The destination byte
Returns:
1 if no error occurs, a negative value otherwise

int flex_Serial_init ( Flex_Serial com,
const char *  port_name,
unsigned int  baud_rate 
)

Open the serial port.

Parameters:
com The Serial Object to open
port_name A valid serial port name
baud_rate A valid serial baud rate
Returns:
1 if no error occurs, 0 otherwise.

int flex_Serial_putc ( Flex_Serial com,
char  data 
)

Write one byte to the serial.

Parameters:
com The serial object
data The byte to write
Returns:
1 if no error occurs, a negative value otherwise

int flex_Serial_read ( Flex_Serial com,
char *  data,
unsigned int  data_size 
)

Read data_size bytes from the serial.

Parameters:
com The serial object
data The destination buffer capable to store the data_size bytes
data_size The number of byte to read
Returns:
the number of bytes read from serial if no error occurs, a negative value otherwise

int flex_Serial_write ( Flex_Serial com,
char *  data,
unsigned int  data_size 
)

Write data_size bytes to the serial.

Parameters:
com The serial object
data The source buffer with the data_size bytes
data_size The number of byte to write
Returns:
the number of bytes written to serial if no error occurs, a negative value otherwise


Generated on Wed Apr 23 00:11:08 2008 for Flex CAM Serial by  doxygen 1.5.4