MHV_HardwareSerial Class Reference

#include <MHV_HardwareSerial.h>

Inheritance diagram for MHV_HardwareSerial:

List of all members.

Public Member Functions
	MHV_HardwareSerial (MHV_RingBuffer *rxBuffer, MHV_RingBuffer *txBuffer, volatile uint16_t *ubrr, volatile uint8_t *ucsra, volatile uint8_t *ucsrb, volatile uint8_t *udr, uint8_t rxen, uint8_t txen, uint8_t rxcie, uint8_t txcie, uint8_t udre, uint8_t u2x, unsigned long baud)
void	setSpeed (unsigned long baud)
void	end ()
void	busyWrite (char c)
void	busyWrite (const char *buffer)
void	busyWrite (const char *buffer, uint16_t length)
void	busyWrite_P (PGM_P buffer)
void	busyWrite_P (PGM_P buffer, uint16_t length)
bool	canSendBusy ()
void	rx ()
void	tx ()
void	echo (bool echoOn)
bool	busy ()
void	debug (const char *file, int line, const char *function, PGM_P format,...)
Protected Member Functions
void	runTxBuffers ()

---

Detailed Description

Definition at line 71 of file MHV_HardwareSerial.h.

---

Constructor & Destructor Documentation

MHV_HardwareSerial::MHV_HardwareSerial	(	MHV_RingBuffer *	rxBuffer,
		MHV_RingBuffer *	txBuffer,
		volatile uint16_t *	ubrr,
		volatile uint8_t *	ucsra,
		volatile uint8_t *	ucsrb,
		volatile uint8_t *	udr,
		uint8_t	rxen,
		uint8_t	txen,
		uint8_t	rxcie,
		uint8_t	txcie,
		uint8_t	udre,
		uint8_t	u2x,
		unsigned long	baud
	)

Constructor

Parameters:

rxBuffer	the receive buffer
txBuffer	the transmit buffer
ubrr	A member of the MHV_USART_* macro
ucsra	See ubrr
ucsrb	See ubrr
udr	See ubrr
rxen	See ubrr
txen	See ubrr
rxcie	See ubrr
txcie	See ubrr
udre	See ubrr
u2x	See ubrr
baud	the baud rate

Definition at line 54 of file MHV_HardwareSerial.cpp.

---

Member Function Documentation

bool MHV_HardwareSerial::busy

(

void

)

Check if the hardware is busy - note that this should not be used to determine if you can actually write - use canSend instead

Returns:

true if the hardware is busy

Definition at line 266 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::busyWrite

(

char

c

)

Write a character

Parameters:

c	the character to write

Definition at line 173 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::busyWrite

(

const char *

buffer

)

Write a null terminated string to the serial port

Parameters:

buffer

the string to write

Definition at line 209 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::busyWrite	(	const char *	buffer,
		uint16_t	length
	)

Write a buffer

Parameters:

buffer	the buffer to write
length	the length of the buffer

Definition at line 246 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::busyWrite_P

(

PGM_P

buffer

)

Write a null terminated progmem string

Parameters:

buffer

the string to write

Definition at line 187 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::busyWrite_P	(	PGM_P	buffer,
		uint16_t	length
	)

Write a buffer from PROGMEM

Parameters:

buffer	the buffer to write
length	the length of the buffer

Definition at line 227 of file MHV_HardwareSerial.cpp.

bool MHV_HardwareSerial::canSendBusy

(

)

Can we send something via busywrite

Returns:

true if we can send something

Definition at line 164 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::debug	(	const char *	file,
		int	line,
		const char *	function,
		PGM_P	format,
			...
	)

Print a debug message

Parameters:

file	the filename
line	the line number
function	the function name
format	a printf format
...	the printf parms

Definition at line 278 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::echo

(

bool

echoOn

)

Enable echoing data received by us back to the sender (useful for terminal interaction

Parameters:

echoOn

true to enable echo

Definition at line 155 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::end

(

)

Halt the serial port

Definition at line 145 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::runTxBuffers

(

)

[protected, virtual]

Start sending async data

Implements MHV_Device_TX.

Definition at line 106 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::rx

(

)

RX interrupt handler

Definition at line 78 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::setSpeed

(

unsigned long

baud

)

Configure the serial port for a specific baud rate

Parameters:

baud	the baud rate to set

Definition at line 126 of file MHV_HardwareSerial.cpp.

void MHV_HardwareSerial::tx

(

)

TX interrupt handler

Definition at line 90 of file MHV_HardwareSerial.cpp.

---

The documentation for this class was generated from the following files:

• A:/eclipse/mhvlib/MHV_HardwareSerial.h
• A:/eclipse/mhvlib/MHV_HardwareSerial.cpp