Add drawIcon() and example

Author: nseidle

examples/Example6_DrawIcon/Example6_DrawIcon.ino

@@ -0,0 +1,139 @@
+/*
+  Micro OLED Display Icon
+  Nathan Seidle @ SparkFun Electronics
+  Original Creation Date: November 15, 2020
+  
+  Draw a variable sized icon anywhere on the display. This is helpful 
+  when you need a icon (GPS, battery, etc) on a certain part of the screen.
+
+  This example assumes an I2C connection (Qwiic)
+  
+  This code is beerware; if you see me (or any other SparkFun 
+  employee) at the local, and you've found our code helpful, 
+  please buy us a round!
+  
+  Distributed as-is; no warranty is given.
+*/
+#include <Wire.h>
+#include <SFE_MicroOLED.h> //Click here to get the library: http://librarymanager/All#SparkFun_Micro_OLED
+
+#define PIN_RESET 9
+#define DC_JUMPER 1 // Set to either 0 (SPI, default) or 1 (I2C) based on jumper, matching the value of the DC Jumper
+MicroOLED oled(PIN_RESET, DC_JUMPER);
+
+//A 20 x 17 pixel image of a truck in a box
+//Use http://en.radzio.dxp.pl/bitmap_converter/ to generate output
+//Make sure the bitmap is n*8 pixels tall (pad white pixels to lower area as needed)
+//Otherwise the bitmap bitmap_converter will compress some of the bytes together
+uint8_t truck[] = {
+    0xFF,
+    0x01,
+    0xC1,
+    0x41,
+    0x41,
+    0x41,
+    0x71,
+    0x11,
+    0x11,
+    0x11,
+    0x11,
+    0x11,
+    0x71,
+    0x41,
+    0x41,
+    0xC1,
+    0x81,
+    0x01,
+    0xFF,
+    0xFF,
+    0x80,
+    0x83,
+    0x82,
+    0x86,
+    0x8F,
+    0x8F,
+    0x86,
+    0x82,
+    0x82,
+    0x82,
+    0x86,
+    0x8F,
+    0x8F,
+    0x86,
+    0x83,
+    0x81,
+    0x80,
+    0xFF,
+};
+
+int iconHeight = 17;
+int iconWidth = 20;
+
+bool displayDetected = false;
+
+void setup()
+{
+  Wire.begin();
+  Wire.setClock(400000);
+
+  Serial.begin(115200);
+  delay(100);
+  Serial.println("Display Icon OLED example");
+
+  //0x3D is default address on Qwiic board
+  if (isConnected(0x3D) == true || isConnected(0x3C) == true)
+  {
+    Serial.println("Display detected");
+    displayDetected = true;
+  }
+  else
+  {
+    Serial.println("No display detected. Freezing...");
+    while (1)
+      ;
+  }
+
+  if (displayDetected)
+  {
+    oled.begin();     // Initialize the OLED
+    oled.clear(PAGE); // Clear the display's internal memory
+    oled.clear(ALL);  // Clear the library's display buffer
+    oled.display();   // Display what's in the buffer (splashscreen)
+  }
+}
+
+int iconX = 0;
+int iconXChangeAmount = 1;
+int iconY = 0;
+int iconYChangeAmount = 1;
+
+void loop()
+{
+  if (displayDetected)
+  {
+    oled.drawIcon(iconX, iconY, iconWidth, iconHeight, truck, sizeof(truck), true);
+    oled.display();
+
+    //Move the icon
+    iconX += iconXChangeAmount;
+    iconY += iconYChangeAmount;
+
+    if (iconX + iconWidth >= 64)
+      iconXChangeAmount *= -1; //Change direction
+    if (iconX == 0)
+      iconXChangeAmount *= -1; //Change direction
+
+    if (iconY + iconHeight >= 48)
+      iconYChangeAmount *= -1; //Change direction
+    if (iconY == 0)
+      iconYChangeAmount *= -1; //Change direction
+  }
+}
+
+bool isConnected(uint8_t deviceAddress)
+{
+  Wire.beginTransmission(deviceAddress);
+  if (Wire.endTransmission() == 0)
+    return true;
+  return false;
+}

examples/Example6_DrawIcon/truck.bmp

@@ -1047,3 +1047,50 @@ void MicroOLED::drawBitmap(uint8_t *bitArray)
 	for (int i = 0; i < (LCDWIDTH * LCDHEIGHT / 8); i++)
 		screenmemory[i] = bitArray[i];
 }
+
+//Draw an icon at a given spot
+//Use http://en.radzio.dxp.pl/bitmap_converter/ to generate output
+//Make sure the bitmap is n*8 pixels tall (pad white pixels to lower area as needed)
+//Otherwise the bitmap bitmap_converter will compress some of the bytes together
+void MicroOLED::drawIcon(uint8_t offsetX, uint8_t offsetY, uint8_t iconWidth, uint8_t iconHeight, uint8_t *bitArray, uint8_t arraySizeInBytes, bool overwrite)
+{
+	uint8_t columnNumber = offsetX;
+	uint8_t rowNumber = offsetY / 8;
+
+	uint8_t bitOffset = offsetY % 8;
+
+	for (uint8_t i = 0; i < arraySizeInBytes; i++)
+	{
+		uint16_t byteNumber = rowNumber * 64 + columnNumber;
+
+		//If we have an offset, then straddle the bytes between rows
+		if (bitOffset)
+		{
+			//Zero out the bits before entering new data
+			if (overwrite == true)
+			{
+				screenmemory[byteNumber] &= ~(0xFF << bitOffset);
+				screenmemory[byteNumber + 64] &= ~(0xFF >> (8 - bitOffset));
+			}
+
+			//Write in new data across two rows
+			screenmemory[byteNumber] |= bitArray[i] << bitOffset;
+			screenmemory[byteNumber + 64] |= bitArray[i] >> (8 - bitOffset);
+		}
+		else //No shift needed
+		{
+			//Regular clear
+			if (overwrite == true)
+				screenmemory[byteNumber] = 0;
+			screenmemory[byteNumber] |= bitArray[i];
+		}
+
+		columnNumber++;
+		if (columnNumber == offsetX + iconWidth - 1)
+		{
+			//Wrap to next row
+			rowNumber++;
+			columnNumber = offsetX;
+		}
+	}
+}

src/SFE_MicroOLED.cpp

@@ -177,6 +177,7 @@ class MicroOLED : public Print
 	void drawChar(uint8_t x, uint8_t y, uint8_t c);
 	void drawChar(uint8_t x, uint8_t y, uint8_t c, uint8_t color, uint8_t mode);
 	void drawBitmap(uint8_t *bitArray);
+	void drawIcon(uint8_t locationX, uint8_t locationY, uint8_t iconWidth, uint8_t iconHeight, uint8_t *bitArray, uint8_t arraySizeInBytes, bool overwrite = false);
 	uint8_t getLCDWidth(void);
 	uint8_t getLCDHeight(void);
 	void setColor(uint8_t color);