Main Page   Compound List   File List   Compound Members   File Members  

serapi_t.h File Reference

Serial API - type definition. More...

Go to the source code of this file.

Compounds

struct  statusStr
 This struct is for easy handling the status queried by the getStatus(...) funtion. More...


Defines

#define FOS_INT   0x14
 This is the interrupt for accessing fossil funtions. More...

#define COM   1
 These are the serial port macros. More...

#define EXT   0
#define TRANSMIT_XONXOFF   1
 These are the flow control macros. More...

#define RECEIVE_XONXOFF   8
#define RTSCTS   2
#define NO_FLOWCTRL   0
#define TX_ENABLE_LOW   0
 These macros are for the RS485 mode. More...

#define TX_ENABLE_HIGH   1
#define NO_STATUS   255
 This macro is for pointing that no statusbyte is given in a funtion. More...


Typedefs

typedef unsigned char byte
 An byte is an unsigned char. More...

typedef unsigned int bool
 The defined bool datatype is a unsigned int and is for helping me to compensate the lack of the apropriate type in C. More...

typedef struct statusStr  statusSTR
 This struct is for easy handling the status queried by the getStatus(...) funtion. More...

typedef statusSTRstatusPtr


Detailed Description

Serial API - type definition.

Author:
Christian Decker (cdecker@teco.edu)

Development \bSystem: Turbo C++ 3.0

Licence: GPL

This API was developed for easy handling the Fossil functions of the SC12 by Beck GmbH. The code was inspired from a snippet which I found in the examples delivered with the original API descriptions from Beck.

This API contains functions for initializing and deinitializing a serial port. Furthermore there are functions for setting parameters of the interface like baudrate, parity etc. and for sending and receiving bytes or whole data blocks.

See also:
http://www.beck-ip.com/ , http://www.teco.edu/~cdecker/ , cdecker@teco.edu

Definition in file serapi_t.h.


Define Documentation

#define COM   1
 

These are the serial port macros.

It should be self-explanatory. :-)

Definition at line 36 of file serapi_t.h.

#define EXT   0
 

Definition at line 37 of file serapi_t.h.

#define FOS_INT   0x14
 

This is the interrupt for accessing fossil funtions.

Definition at line 30 of file serapi_t.h.

#define NO_FLOWCTRL   0
 

Definition at line 49 of file serapi_t.h.

#define NO_STATUS   255
 

This macro is for pointing that no statusbyte is given in a funtion.

Definition at line 90 of file serapi_t.h.

#define RECEIVE_XONXOFF   8
 

Definition at line 47 of file serapi_t.h.

#define RTSCTS   2
 

Definition at line 48 of file serapi_t.h.

#define TRANSMIT_XONXOFF   1
 

These are the flow control macros.

TRANSMIT_XONXOFF means XON/XOFF on transmit (watch for XOFF while sending) RECEIVE_XONXOFF means XON/XOFF on receive (send XOFF when buffer near full) RTSCTS means CTS/RTS (CTS on transmit/RTS on receive) NONE means no flow control

Definition at line 46 of file serapi_t.h.

#define TX_ENABLE_HIGH   1
 

Definition at line 55 of file serapi_t.h.

#define TX_ENABLE_LOW   0
 

These macros are for the RS485 mode.

Definition at line 54 of file serapi_t.h.


Typedef Documentation

typedef unsigned int bool
 

The defined bool datatype is a unsigned int and is for helping me to compensate the lack of the apropriate type in C.

Definition at line 71 of file serapi_t.h.

typedef unsigned char byte
 

An byte is an unsigned char.

That should ease the understanding of sending/receiving a byte.

Definition at line 63 of file serapi_t.h.

typedef statusSTR * statusPtr
 

Definition at line 85 of file serapi_t.h.

typedef struct statusStr statusSTR
 

This struct is for easy handling the status queried by the getStatus(...) funtion.


Generated at Fri Oct 26 12:43:46 2001 for SerialAPI by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001