commit before delete

Author: Kirk

examples/Example5_DisplayBitmap/Example5_DisplayBitmap.ino

@@ -1,43 +1,102 @@
-/*
-  SFE_MicroOLED Display Bitmap
-  Joel Bartlett @ SparkFun Electronics
-  Original Creation Date: January 20, 2015
+// Example-08_Bitmap.ino
+// 
+// This is a library written for SparkFun Qwiic OLED boards that use the SSD1306.
+//
+// SparkFun sells these at its website: www.sparkfun.com
+//
+// Do you like this library? Help support SparkFun. Buy a board!
+//
+//   Micro OLED             https://www.sparkfun.com/products/14532
+//   Transparent OLED       https://www.sparkfun.com/products/15173
+//   "Narrow" OLED          https://www.sparkfun.com/products/17153
+// 
+// 
+// Written by 
+//    Joel Bartlett @ SparkFun Electronics
+//    Original Creation Date: January 20, 2015
+//
+// This library configures and draws graphics to OLED boards that use the 
+// SSD1306 display hardware. The library only supports I2C.
+// 
+// Repository:
+//     https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library
+//
+// Documentation:
+//     https://sparkfun.github.io/SparkFun_Qwiic_OLED_Arduino_Library/
+//
+//
+// SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
+//
+// SPDX-License-Identifier: MIT
+//
+//    The MIT License (MIT)
+//
+//    Copyright (c) 2022 SparkFun Electronics
+//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+//    associated documentation files (the "Software"), to deal in the Software without restriction,
+//    including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+//    and/or sell copies of the Software, and to permit persons to whom the Software is furnished to
+//    do so, subject to the following conditions:
+//    The above copyright notice and this permission notice shall be included in all copies or substantial
+//    portions of the Software.
+//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+//    NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+//    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+//    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-  This sketch shows you how to draw a 64x48 pixel Bitmap image on the MicroOLED.
+// Example 08 for the SparkFun Qwiic OLED Arduino Library
+//
+// >> Overview <<
+//
+// Draws a simple bitmap on a OLED. 
+//
+//////////////////////////////////////////////////////////////////////////////////////////
+// >>> SELECT THE CONNECTED DEVICE FOR THIS EXAMPLE <<<
+//
+// The Library supports three different types of SparkFun boards. The demo uses the following
+// defines to determine which device is being used. Uncomment the device being used for this demo.
+//
+// The default is Micro OLED
 
-  Hardware Connections:
-    This example assumes you are using Qwiic. See the SPI examples for
-    a detailed breakdown of connection info.
+//#define MICRO
+//#define NARROW
+#define TRANSPARENT
 
-  Note: The display on the MicroOLED is a 1.8V-3.3V device only.
-  Don't try to connect a 5V Arduino directly to it! Use level
-  shifters in between the data signals if you have to resort to
-  a 5V board.
+//////////////////////////////////////////////////////////////////////////////////////////
 
-  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!
+#include <stdint.h>
 
-  Distributed as-is; no warranty is given.
-*/
+// Include the SparkFun qwiic OLED Library
+#include <SparkFun_Qwiic_OLED.h>
 
-#include <Wire.h>
-#include <SFE_MicroOLED.h> //Click here to get the library: http://librarymanager/All#SparkFun_Micro_OLED
+// What device is being used in this demo
 
+#if defined(TRANSPARENT)
+QwiicTransparentOLED myOLED;
+const char * deviceName = "Transparent OLED";
 
-#define kMicroOLEDAddress 0x3D
-#define kNarrowOLEDAddress  0x3C
+#elif defined(NARROW)
+QwiicNarrowOLED myOLED;
+const char * deviceName = "Narrow OLED";
+
+#else
+QwiicMicroOLED myOLED;
+const char * deviceName = "Micro OLED";
+
+#endif
 
-#define DC_JUMPER 1
-#define PIN_RESET 9 // Optional - Connect RST on display to pin 9 on Arduino
 
-MicroOLED oled(PIN_RESET, kNarrowOLEDAddress, 128, 32); // I2C declaration
 //------------------------------------------------------------------------------
 // File generated by LCD Assistant
 // http://en.radzio.dxp.pl/bitmap_converter/
 //------------------------------------------------------------------------------
 //This is the array that holds the Bitmap image. The easiest way to convert a bmp
 //to an array is to use the LCD Assistant linked above.
+
+#define BMP_WIDTH  64
+#define BMP_HEIGHT 48
+
 uint8_t bender[] = {
     0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x7F, 0xBF, 0xDF, 0x5F, 0x5F, 0x5F, 0x5F,
     0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F, 0x5F,
@@ -64,29 +123,33 @@ uint8_t bender[] = {
     0xFB, 0xFB, 0xFB, 0xF8, 0xFB, 0xFD, 0xFD, 0xFC, 0xFE, 0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
     0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
 
-// I2C is great, but will result in a much slower update rate. The
-// slower framerate may be a worthwhile tradeoff, if you need more
-// pins, though.
+// Very siomple 
 void setup()
 {
-  delay(100);   //Give display time to power on
-  Wire.begin(); //Setup I2C bus
-
-  // Before you can start using the OLED, call begin() to init
-  // all of the pins and configure the OLED.
-  oled.begin();
-  // clear(ALL) will clear out the OLED's graphic memory.
-  // clear(PAGE) will clear the Arduino's display buffer.
-  oled.clear(ALL); // Clear the display's memory (gets rid of artifacts)
-  // To actually draw anything on the display, you must call the
-  // display() function.
-  oled.display();
-  delay(1000); //pause for the splash screen
-  //Note: You can change the spalsh screen by editing the array founf in the library source code
-
-  oled.clear(PAGE);        //clear the screen before we draw our image
-  oled.drawBitmap(bender); //call the drawBitmap function and pass it the array from above
-  oled.display();          //display the imgae
+
+    delay(500);   //Give display time to power on
+
+    // Serial on!
+    Serial.begin(115200);
+
+    Serial.println("\n\r-----------------------------------");
+
+    Serial.print("Running Example 01 on: ");
+    Serial.println(String(deviceName));
+
+    // Initalize the OLED device and related graphics system
+    if(!myOLED.begin()){
+
+        Serial.println(" - Device Begin Failed");
+        while(1);
+    }
+
+    Serial.println("- Begin Success");
+  
+    // Draw the bitmap
+    myOLED.bitmap(0, 0, BMP_WIDTH, BMP_HEIGHT, bender, BMP_WIDTH, BMP_HEIGHT);
+    myOLED.display();
+
 }
 
 void loop()