Adding enableDebugging. Corrected line (missing last pixel)

Author: PaulZC

keywords.txt

@@ -14,6 +14,7 @@ MicroOLED	KEYWORD1
 
 begin	KEYWORD2
 invert	KEYWORD2
+enableDebugging	KEYWORD2
 clear	KEYWORD2
 invert	KEYWORD2
 contrast	KEYWORD2

src/SFE_MicroOLED.cpp

@@ -69,13 +69,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define TOTALFONTS 4
 #endif
 
-#define swapOLED(a, b) \
-	{                  \
-		uint8_t t = a; \
-		a = b;         \
-		b = t;         \
-	}
-
 // Add the font name as declared in the header file.  Remove as many as possible to conserve FLASH memory.
 const unsigned char *MicroOLED::fontsPointer[] = {
 	font5x7, font8x16, sevensegment, fontlargenumber
@@ -272,6 +265,14 @@ void MicroOLED::begin()
 	clear(ALL);			// Erase hardware memory inside the OLED controller to avoid random data in memory.
 }
 
+//Calling this function with nothing sets the debug port to Serial
+//You can also call it with other streams like Serial1, SerialUSB, etc.
+void MicroOLED::enableDebugging(Stream &debugPort)
+{
+	_debugPort = &debugPort;
+	_printDebug = true;
+}
+
 /** \brief Send the display a command byte
 
     Send a command via SPI, I2C or parallel	to SSD1306 controller.
@@ -556,26 +557,70 @@ Draw line using color and mode from x0,y0 to x1,y1 of the screen buffer.
 */
 void MicroOLED::line(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, uint8_t color, uint8_t mode)
 {
+	if (_printDebug == true)
+	{
+		_debugPort->print(F("line: line coords: ("));
+		_debugPort->print(x0);
+		_debugPort->print(F(","));
+		_debugPort->print(y0);
+		_debugPort->print(F(") ("));
+		_debugPort->print(x1);
+		_debugPort->print(F(","));
+		_debugPort->print(y1);
+		_debugPort->println(F(")"));
+	}
+
 	uint8_t steep = abs(y1 - y0) > abs(x1 - x0);
 	if (steep)
 	{
-		swapOLED(x0, y0);
-		swapOLED(x1, y1);
-	}
+		swapOLED(&x0, &y0);
+		swapOLED(&x1, &y1);
+		if (_printDebug == true)
+			_debugPort->println(F("line: line is steep"));
+}
 
 	if (x0 > x1)
 	{
-		swapOLED(x0, x1);
-		swapOLED(y0, y1);
+		swapOLED(&x0, &x1);
+		swapOLED(&y0, &y1);
+		if (_printDebug == true)
+			_debugPort->println(F("line: x0 > x1"));
 	}
 
+	// if (_printDebug == true)
+	// {
+	// 	_debugPort->print(F("line: line coords: ("));
+	// 	_debugPort->print(x0);
+	// 	_debugPort->print(F(","));
+	// 	_debugPort->print(y0);
+	// 	_debugPort->print(F(") ("));
+	// 	_debugPort->print(x1);
+	// 	_debugPort->print(F(","));
+	// 	_debugPort->print(y1);
+	// 	_debugPort->println(F(")"));
+	// }
+
 	uint8_t dx, dy;
 	dx = x1 - x0;
 	dy = abs(y1 - y0);
 
+	if (_printDebug == true)
+	{
+		_debugPort->print(F("line: dx: "));
+		_debugPort->print(dx);
+		_debugPort->print(F("  dy: "));
+		_debugPort->println(dy);
+	}
+
 	int8_t err = dx / 2;
 	int8_t ystep;
 
+	if (_printDebug == true)
+	{
+		_debugPort->print(F("line: err: "));
+		_debugPort->println(err);
+	}
+
 	if (y0 < y1)
 	{
 		ystep = 1;
@@ -585,15 +630,37 @@ void MicroOLED::line(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, uint8_t col
 		ystep = -1;
 	}
 
-	for (; x0 < x1; x0++)
+	if (_printDebug == true)
+	{
+		_debugPort->print(F("line: ystep: "));
+		_debugPort->println(ystep);
+	}
+
+	for (; x0 <= x1; x0++)
 	{
 		if (steep)
 		{
 			pixel(y0, x0, color, mode);
+			if (_printDebug == true)
+			{
+				_debugPort->print(F("line: steep pixel: ("));
+				_debugPort->print(y0);
+				_debugPort->print(F(","));
+				_debugPort->print(x0);
+				_debugPort->println(F(")"));
+			}
 		}
 		else
 		{
 			pixel(x0, y0, color, mode);
+			if (_printDebug == true)
+			{
+				_debugPort->print(F("line: pixel: ("));
+				_debugPort->print(x0);
+				_debugPort->print(F(","));
+				_debugPort->print(y0);
+				_debugPort->println(F(")"));
+			}
 		}
 		err -= dy;
 		if (err < 0)
@@ -1193,3 +1260,10 @@ uint8_t MicroOLED::getI2CTransactionSize(void)
 {
   return (i2cTransactionSize);
 }
+
+void MicroOLED::swapOLED(uint8_t *x, uint8_t *y)
+{
+	uint8_t t = *x;
+	*x = *y;
+	*y = t;
+}

src/SFE_MicroOLED.h

@@ -154,6 +154,8 @@ class MicroOLED : public Print
 	void begin(void);
 	virtual size_t write(uint8_t);
 
+	void enableDebugging(Stream &debugPort = Serial); //Turn on debug printing. If user doesn't specify then Serial will be used.
+
 	// RAW LCD functions
 	void command(uint8_t c);
 	void data(uint8_t c);
@@ -231,6 +233,11 @@ class MicroOLED : public Print
 	uint8_t foreColor, drawMode, fontWidth, fontHeight, fontType, fontStartChar, fontTotalChar, cursorX, cursorY;
 	uint16_t fontMapWidth;
 	static const unsigned char *fontsPointer[];
+	void swapOLED(uint8_t *x, uint8_t *y);
+
+	//Debug
+	Stream *_debugPort;			 //The stream to send debug messages to if enabled. Usually Serial.
+	boolean _printDebug = false; //Flag to print debugging variables
 
 	// Communication
 	void spiTransfer(byte data);