MySerial Class Reference

#include <Serial.h>

Inheritance diagram for MySerial:

Public Member Functions
	MySerial (StringList &li, bool &dbg, uint8_t receivePin, uint8_t transmitPin, bool inverse_logic=false)
virtual int	read ()
virtual size_t	write (uint8_t byte)

Protected Attributes
char	inData [255]
	Helper data for a serial write.
int	inIdx
	How many bytes are written.
char	outData [255]
	Helper data for a serial read.
int	outIdx
	How many bytes are read.
StringList &	logInfos
	Hook pointer for the data logging.
bool &	debug
	Enable or disable the hooking.

Detailed Description

Helper class to hook the SoftwareSerial calls to log the information for the console.

Definition at line 26 of file Serial.h.

Constructor & Destructor Documentation

MySerial::MySerial	(	StringList &	li,
		bool &	dbg,
		uint8_t	receivePin,
		uint8_t	transmitPin,
		bool	inverse_logic = false
	)

Constructor

Definition at line 46 of file Serial.h.

   : SoftwareSerial(receivePin, transmitPin, inverse_logic)
   , inIdx(0)
   , outIdx(0)
   , logInfos(li)
   , debug(dbg)
{
}

Member Function Documentation

int MySerial::read ( )

virtual

Virtual function call on read operations. We check for incomming calls.

Definition at line 58 of file Serial.h.

References StringList::addTail(), debug, inData, inIdx, and logInfos.

{
   int ret = SoftwareSerial::read();

   if (ret >= 0 && debug) {
      char c = (char) ret;

      if (c != '\r' && c != '\n') {
         if (inIdx < 250) {
            inData[inIdx++] = c;
         }
      } else {
         if (inIdx > 0) {
            inData[inIdx] = 0;

            String info = (String) F("< ") + (String) inData;
            logInfos.addTail(info);
            // Pass thrue to the default Serial for debugging
            Serial.println(info);
         }
         inIdx = 0;
      }
   }

   return ret;
}

size_t MySerial::write ( uint8_t  byte )

virtual

Virtual function call on write operations

Definition at line 86 of file Serial.h.

References StringList::addTail(), debug, logInfos, outData, and outIdx.

{
   size_t ret = SoftwareSerial::write(byte);

   if (debug) {
      char c = (char)byte;

      if (c != '\r' && c != '\n') {
         if (outIdx < 250) {
            outData[outIdx++] = c;
         }
      } else {
         if (outIdx > 0) {
            outData[outIdx] = 0;

            String info = (String) F("> ") + (String)outData;

            logInfos.addTail(info);
            // Pass thrue to the default Serial for debugging
            Serial.println(info);
         }
         outIdx = 0;
      }
   }
   return ret;
}

---

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

• tracker/Serial.h