Merge pull request #11 from sparkfun/Add_Qwiic_OLED_1in3

gigapod · web-flow · commit edca24bb5a27 · 2023-09-26T10:42:12.000-06:00
Add Qwiic OLED 1.3" (Qwiic1in3OLED)
diff --git a/docs/software.md b/docs/software.md
@@ -28,6 +28,7 @@ The user selects from one of the following classes:
 | `QwiicMicroOLED` | [SparkFun Qwiic Micro OLED ]( https://www.sparkfun.com/products/14532)| 
 | `QwiicNarrowOLED` | [SparkFun Qwiic OLED Display (128x32) ]( https://www.sparkfun.com/products/17153)| 
 | `QwiicTransparentOLED` | [SparkFun Transparent Graphical OLED]( https://www.sparkfun.com/products/15173)| 
+| `Qwiic1in3OLED` | [SparkFun Qwiic OLED 1.3" Display (128x32) ]( https://www.sparkfun.com/products/23453)| 
 
 For this example, the Qwiic Micro OLED is used.
 ```C++
diff --git a/examples/Example-01_Hello/Example-01_Hello.ino b/examples/Example-01_Hello/Example-01_Hello.ino
@@ -20,14 +20,15 @@
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
 
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 
 void setup()
diff --git a/examples/Example-02_Shapes/Example-02_Shapes.ino b/examples/Example-02_Shapes/Example-02_Shapes.ino
@@ -25,14 +25,15 @@
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
 
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 // Global variables - used to stash our screen size
 
diff --git a/examples/Example-03_Bitmap/Example-03_Bitmap.ino b/examples/Example-03_Bitmap/Example-03_Bitmap.ino
@@ -25,14 +25,15 @@
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
 
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 // Let's draw a truck - use our built in bitmap
 #include "res/qw_bmp_truck.h"
diff --git a/examples/Example-04_Text/Example-04_Text.ino b/examples/Example-04_Text/Example-04_Text.ino
@@ -25,14 +25,15 @@
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
 
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 // Fonts
 #include <res/qw_fnt_5x7.h>
diff --git a/examples/Example-05_ScrollFlip/Example-05_ScrollFlip.ino b/examples/Example-05_ScrollFlip/Example-05_ScrollFlip.ino
@@ -27,14 +27,15 @@
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
 
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 int yoffset;
 
diff --git a/examples/Example-06_Clock/Example-06_Clock.ino b/examples/Example-06_Clock/Example-06_Clock.ino
@@ -27,14 +27,15 @@
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
 
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 // Use these variables to set the initial time
 int hours = 11;
diff --git a/examples/Example-07_Cube/Example-07_Cube.ino b/examples/Example-07_Cube/Example-07_Cube.ino
@@ -26,14 +26,15 @@
 
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 int width;
 int height;
diff --git a/examples/Example-08_Multi/Example-08_Multi.ino b/examples/Example-08_Multi/Example-08_Multi.ino
@@ -26,14 +26,15 @@
   SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).
 */
 
-#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_Graphic_OLED
+#include <SparkFun_Qwiic_OLED.h> //http://librarymanager/All#SparkFun_Qwiic_OLED
 
 // 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.
 
 QwiicMicroOLED myOLED;
 // QwiicTransparentOLED myOLED;
 // QwiicNarrowOLED myOLED;
+// Qwiic1in3OLED myOLED;
 
 int width;
 int height;
diff --git a/examples/docs/ex_01_hello.md b/examples/docs/ex_01_hello.md
@@ -26,6 +26,7 @@ The user selects from one of the following classes:
 | `QwiicMicroOLED` | [SparkFun Qwiic Micro OLED ]( https://www.sparkfun.com/products/14532)| 
 | `QwiicNarrowOLED` | [SparkFun Qwiic OLED Display (128x32) ]( https://www.sparkfun.com/products/17153)| 
 | `QwiicTransparentOLED` | [SparkFun Transparent Graphical OLED]( https://www.sparkfun.com/products/15173)| 
+| `Qwiic1in3OLED` | [SparkFun Qwiic OLED 1.3" Display (128x32) ]( https://www.sparkfun.com/products/23453)| 
 
 The Example code supports all of the SparkFun Qwiic OLED boards. To select the board being used, uncomment the `#define` for the demo board. 
 
diff --git a/examples/docs/ex_02_lines.md b/examples/docs/ex_02_lines.md
@@ -25,6 +25,7 @@ The user selects from one of the following classes:
 | `QwiicMicroOLED` | [SparkFun Qwiic Micro OLED ]( https://www.sparkfun.com/products/14532)| 
 | `QwiicNarrowOLED` | [SparkFun Qwiic OLED Display (128x32) ]( https://www.sparkfun.com/products/17153)| 
 | `QwiicTransparentOLED` | [SparkFun Transparent Graphical OLED]( https://www.sparkfun.com/products/15173)| 
+| `Qwiic1in3OLED` | [SparkFun Qwiic OLED 1.3" Display (128x32) ]( https://www.sparkfun.com/products/23453)| 
 
 The Example code supports all of the SparkFun Qwiic OLED boards. To select the board being used, uncomment the `#define` for the demo board. 
 
diff --git a/examples/docs/ex_03_bitmaps.md b/examples/docs/ex_03_bitmaps.md
@@ -25,6 +25,7 @@ The user selects from one of the following classes:
 | `QwiicMicroOLED` | [SparkFun Qwiic Micro OLED ]( https://www.sparkfun.com/products/14532)| 
 | `QwiicNarrowOLED` | [SparkFun Qwiic OLED Display (128x32) ]( https://www.sparkfun.com/products/17153)| 
 | `QwiicTransparentOLED` | [SparkFun Transparent Graphical OLED]( https://www.sparkfun.com/products/15173)| 
+| `Qwiic1in3OLED` | [SparkFun Qwiic OLED 1.3" Display (128x32) ]( https://www.sparkfun.com/products/23453)| 
 
 The Example code supports all of the SparkFun Qwiic OLED boards. To select the board being used, uncomment the `#define` for the demo board. 
 
diff --git a/examples/docs/ex_04_text.md b/examples/docs/ex_04_text.md
@@ -25,6 +25,7 @@ The user selects from one of the following classes:
 | `QwiicMicroOLED` | [SparkFun Qwiic Micro OLED ]( https://www.sparkfun.com/products/14532)| 
 | `QwiicNarrowOLED` | [SparkFun Qwiic OLED Display (128x32) ]( https://www.sparkfun.com/products/17153)| 
 | `QwiicTransparentOLED` | [SparkFun Transparent Graphical OLED]( https://www.sparkfun.com/products/15173)| 
+| `Qwiic1in3OLED` | [SparkFun Qwiic OLED 1.3" Display (128x32) ]( https://www.sparkfun.com/products/23453)| 
 
 The Example code supports all of the SparkFun Qwiic OLED boards. To select the board being used, uncomment the `#define` for the demo board. 
 
diff --git a/keywords.txt b/keywords.txt
@@ -9,6 +9,7 @@
 QwiicTransparentOLED	KEYWORD1
 QwiicNarrowOLED	KEYWORD1
 QwiicMicroOLED	KEYWORD1
+Qwiic1in3OLED	KEYWORD1
 QwiicFont	KEYWORD1
 grRasterOp_t	KEYWORD1
 
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=SparkFun Qwiic OLED Arduino Library
-version=1.0.6
+version=1.0.8
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=Library for SparkFun SSD1306 based OLED display products.
diff --git a/src/SparkFun_Qwiic_OLED.h b/src/SparkFun_Qwiic_OLED.h
@@ -52,6 +52,7 @@
 #include "qwiic_oledmicro.h"
 #include "qwiic_olednarrow.h"
 #include "qwiic_oledtransp.h"
+#include "qwiic_oled_1in3.h"
 
 #include <Arduino.h>
 #include <Wire.h>
@@ -831,3 +832,7 @@ class QwiicNarrowOLED : public QwiicOLEDBaseClass<QwOLEDNarrow> {
 class QwiicTransparentOLED : public QwiicOLEDBaseClass<QwOLEDTransparent> {
     // nothing here - see above
 };
+
+class Qwiic1in3OLED : public QwiicOLEDBaseClass<QwOLED1in3> {
+    // nothing here - see above
+};
diff --git a/src/qwiic_oled_1in3.h b/src/qwiic_oled_1in3.h
@@ -0,0 +1,99 @@
+// qwiic_oled_1in3.h
+//
+// 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
+//   1.3" OLED              https://www.sparkfun.com/products/23453
+//
+//
+// Written by Kirk Benell @ SparkFun Electronics, March 2022
+//
+// 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.
+
+// Implementation for the 1.3" OLED device
+
+#pragma once
+
+#include "qwiic_grssd1306.h"
+
+//////////////////////////////////////////////////////////////////
+// Set the defaults for the SparkFun Qwiic MicroOLED
+
+#define kOLED1in3Width 128
+#define kOLED1in3Height 64
+
+#define kOLED1in3XOffset 0
+#define kOLED1in3YOffset 0
+
+// Parameters for this device
+#define kOLED1in3PinConfig 0x12
+#define kOLED1in3PreCharge 0xF1
+#define kOLED1in3VCOM 0x40
+#define kOLED1in3Contrast 0xCF
+
+#define kOLED1in3DefaultAddress 0x3D
+#define kOLED1in3AltAddress 0x3C
+
+class QwOLED1in3 : public QwGrSSD1306 {
+
+public:
+    // Constructor - setup the viewport and default address for this device.
+    QwOLED1in3()
+        : QwGrSSD1306(kOLED1in3XOffset, kOLED1in3YOffset, kOLED1in3Width, kOLED1in3Height)
+    {
+        default_address = kOLED1in3DefaultAddress;
+    };
+
+    // set up the specific device settings
+    bool init(void)
+    {
+
+        setBuffer(m_graphicsBuffer); // The buffer to use
+
+        setCommPins(kOLED1in3PinConfig);
+        setPreCharge(kOLED1in3PreCharge);
+        setVcomDeselect(kOLED1in3VCOM);
+        setContrast(kOLED1in3Contrast);
+
+        // Call the super class to do all the work
+        return this->QwGrSSD1306::init();
+    };
+
+private:
+    // Graphics buffer for this device.
+    uint8_t m_graphicsBuffer[kOLED1in3Width * kOLED1in3Height / 8];
+};
