HalSerial Class Reference

#include <serial.h>

Collaboration diagram for HalSerial:

Public Member Functions
	HalSerial ()
void	begin (int32_t)
void	end ()
int	peek ()
int	read ()
size_t	write (char c)
	operator bool ()
uint16_t	available ()
void	flush ()
uint8_t	availableForWrite ()
void	flushTX ()
void	printf (const char *format,...)
void	print_bin (uint32_t value, uint8_t num_digits)
void	print (const char value[])
void	print (char value, int nbase=0)
void	print (unsigned char value, int nbase=0)
void	print (int value, int nbase=0)
void	print (unsigned int value, int nbase=0)
void	print (long value, int nbase=0)
void	print (unsigned long value, int nbase=0)
void	print (float value, int round=6)
void	print (double value, int round=6)
void	println (const char value[])
void	println (char value, int nbase=0)
void	println (unsigned char value, int nbase=0)
void	println (int value, int nbase=0)
void	println (unsigned int value, int nbase=0)
void	println (long value, int nbase=0)
void	println (unsigned long value, int nbase=0)
void	println (float value, int round=6)
void	println (double value, int round=6)
void	println ()

Public Attributes
volatile RingBuffer< uint8_t, 128 >	receive_buffer
volatile RingBuffer< uint8_t, 128 >	transmit_buffer
volatile bool	host_connected

Constructor & Destructor Documentation

HalSerial()

HalSerial::HalSerial

(

)

{ host_connected = true; }

Member Function Documentation

begin()

void HalSerial::begin

(

int32_t

)

{}

end()

void HalSerial::end

(

void

)

{}

peek()

int HalSerial::peek

(

void

)

             {
    uint8_t value;
    return receive_buffer.peek(&value) ? value : -1;
  }

Here is the call graph for this function:

read()

int HalSerial::read

(

void

)

{ return receive_buffer.read(); }

Here is the call graph for this function:

write()

size_t HalSerial::write

(

char

c

)

                       {
    if (!host_connected) return 0;
    while (!transmit_buffer.free());
    return transmit_buffer.write(c);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

operator bool()

HalSerial::operator bool

(

)

{ return host_connected; }

available()

uint16_t HalSerial::available

(

void

)

                       {
    return (uint16_t)receive_buffer.available();
  }

Here is the call graph for this function:

flush()

void HalSerial::flush

(

void

)

{ receive_buffer.clear(); }

Here is the call graph for this function:

availableForWrite()

uint8_t HalSerial::availableForWrite

(

void

)

                              {
    return transmit_buffer.free() > 255 ? 255 : (uint8_t)transmit_buffer.free();
  }

Here is the call graph for this function:

flushTX()

void HalSerial::flushTX

(

)

                 {
    if (host_connected)
      while (transmit_buffer.available()) { /* nada */ }
  }

Here is the call graph for this function:

printf()

void HalSerial::printf	(	const char *	format,
			...
	)

                                       {
    static char buffer[256];
    va_list vArgs;
    va_start(vArgs, format);
    int length = vsnprintf((char *) buffer, 256, (char const *) format, vArgs);
    va_end(vArgs);
    if (length > 0 && length < 256) {
      if (host_connected) {
        for (int i = 0; i < length;) {
          if (transmit_buffer.write(buffer[i])) {
            ++i;
          }
        }
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

print_bin()

void HalSerial::print_bin	(	uint32_t	value,
		uint8_t	num_digits
	)

                                                     {
    uint32_t mask = 1 << (num_digits -1);
    for (uint8_t i = 0; i < num_digits; i++) {
      if (!(i %  4) && i) write(' ');
      if (!(i % 16) && i) write(' ');
      if (value & mask)   write('1');
      else                write('0');
      value <<= 1;
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

print() [1/9]

void HalSerial::print

(

const char

value[]

)

{ printf("%s" , value); }

Here is the call graph for this function:

Here is the caller graph for this function:

print() [2/9]

void HalSerial::print	(	char	value,
		int	nbase = 0
	)

                                        {
    if (nbase == BIN) print_bin(value, 8);
    else if (nbase == OCT) printf("%3o", value);
    else if (nbase == HEX) printf("%2X", value);
    else if (nbase == DEC ) printf("%d", value);
    else printf("%c" , value);
  }

Here is the call graph for this function:

print() [3/9]

void HalSerial::print	(	unsigned char	value,
		int	nbase = 0
	)

                                                 {
    if (nbase == BIN) print_bin(value, 8);
    else if (nbase == OCT) printf("%3o", value);
    else if (nbase == HEX) printf("%2X", value);
    else printf("%u" , value);
  }

Here is the call graph for this function:

print() [4/9]

void HalSerial::print	(	int	value,
		int	nbase = 0
	)

                                       {
    if (nbase == BIN) print_bin(value, 16);
    else if (nbase == OCT) printf("%6o", value);
    else if (nbase == HEX) printf("%4X", value);
    else printf("%d", value);
  }

Here is the call graph for this function:

print() [5/9]

void HalSerial::print	(	unsigned int	value,
		int	nbase = 0
	)

                                                {
    if (nbase == BIN) print_bin(value, 16);
    else if (nbase == OCT) printf("%6o", value);
    else if (nbase == HEX) printf("%4X", value);
    else printf("%u" , value);
  }

Here is the call graph for this function:

print() [6/9]

void HalSerial::print	(	long	value,
		int	nbase = 0
	)

                                        {
    if (nbase == BIN) print_bin(value, 32);
    else if (nbase == OCT) printf("%11o", value);
    else if (nbase == HEX) printf("%8X", value);
    else printf("%ld" , value);
  }

Here is the call graph for this function:

print() [7/9]

void HalSerial::print	(	unsigned long	value,
		int	nbase = 0
	)

                                                 {
    if (nbase == BIN) print_bin(value, 32);
    else if (nbase == OCT) printf("%11o", value);
    else if (nbase == HEX) printf("%8X", value);
    else printf("%lu" , value);
  }

Here is the call graph for this function:

print() [8/9]

void HalSerial::print	(	float	value,
		int	round = 6
	)

{ printf("%f" , value); }

Here is the call graph for this function:

print() [9/9]

void HalSerial::print	(	double	value,
		int	round = 6
	)

{ printf("%f" , value); }

Here is the call graph for this function:

println() [1/10]

void HalSerial::println

(

const char

value[]

)

{ printf("%s\n" , value); }

Here is the call graph for this function:

println() [2/10]

void HalSerial::println	(	char	value,
		int	nbase = 0
	)

{ print(value, nbase); println(); }

Here is the call graph for this function:

Here is the caller graph for this function:

println() [3/10]

void HalSerial::println	(	unsigned char	value,
		int	nbase = 0
	)

{ print(value, nbase); println(); }

Here is the call graph for this function:

Here is the caller graph for this function:

println() [4/10]

void HalSerial::println	(	int	value,
		int	nbase = 0
	)

{ print(value, nbase); println(); }

Here is the call graph for this function:

Here is the caller graph for this function:

println() [5/10]

void HalSerial::println	(	unsigned int	value,
		int	nbase = 0
	)

{ print(value, nbase); println(); }

Here is the call graph for this function:

Here is the caller graph for this function:

println() [6/10]

void HalSerial::println	(	long	value,
		int	nbase = 0
	)

{ print(value, nbase); println(); }

Here is the call graph for this function:

Here is the caller graph for this function:

println() [7/10]

void HalSerial::println	(	unsigned long	value,
		int	nbase = 0
	)

{ print(value, nbase); println(); }

Here is the call graph for this function:

Here is the caller graph for this function:

println() [8/10]

void HalSerial::println	(	float	value,
		int	round = 6
	)

{ printf("%f\n" , value); }

Here is the call graph for this function:

println() [9/10]

void HalSerial::println	(	double	value,
		int	round = 6
	)

{ printf("%f\n" , value); }

Here is the call graph for this function:

println() [10/10]

void HalSerial::println

(

void

)

{ print('\n'); }

Here is the call graph for this function:

Member Data Documentation

receive_buffer

volatile RingBuffer<uint8_t, 128> HalSerial::receive_buffer

transmit_buffer

volatile RingBuffer<uint8_t, 128> HalSerial::transmit_buffer

host_connected

volatile bool HalSerial::host_connected