serialib.h File Reference

Header file of the class serialib. This class is used for communication over a serial device. More...

#include <sys/time.h>

Go to the source code of this file.

Classes
class	serialib
	This class is used for communication over a serial device. More...
class	timeOut
	This class can manage a timer which is used as a timeout. More...

Macros
#define	UNUSED(x)   (void)(x)

Enumerations
enum	SerialDataBits {   SERIAL_DATABITS_5 , SERIAL_DATABITS_6 , SERIAL_DATABITS_7 , SERIAL_DATABITS_8 ,   SERIAL_DATABITS_16 }
enum	SerialStopBits { SERIAL_STOPBITS_1 , SERIAL_STOPBITS_1_5 , SERIAL_STOPBITS_2 }
enum	SerialParity {   SERIAL_PARITY_NONE , SERIAL_PARITY_EVEN , SERIAL_PARITY_ODD , SERIAL_PARITY_MARK ,   SERIAL_PARITY_SPACE }

Detailed Description

Header file of the class serialib. This class is used for communication over a serial device.

Author

Philippe Lucidarme (University of Angers)

Version

2.0

Date

december the 27th of 2019 This Serial library is used to communicate through serial port.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This is a licence-free software, it can be used by anyone who try to build a better world.

Macro Definition Documentation

UNUSED

#define UNUSED

(

x

)

(void)(x)

To avoid unused parameters

Enumeration Type Documentation

SerialDataBits

enum SerialDataBits

number of serial data bits

Enumerator
SERIAL_DATABITS_5	5 databits
SERIAL_DATABITS_6	6 databits
SERIAL_DATABITS_7	7 databits
SERIAL_DATABITS_8	8 databits
SERIAL_DATABITS_16	16 databits

SerialParity

enum SerialParity

type of serial parity bits

Enumerator
SERIAL_PARITY_NONE	no parity bit
SERIAL_PARITY_EVEN	even parity bit
SERIAL_PARITY_ODD	odd parity bit
SERIAL_PARITY_MARK	mark parity
SERIAL_PARITY_SPACE	space bit

SerialStopBits

enum SerialStopBits

number of serial stop bits

Enumerator
SERIAL_STOPBITS_1	1 stop bit
SERIAL_STOPBITS_1_5	1.5 stop bits
SERIAL_STOPBITS_2	2 stop bits