Various improvements

Author: FWeinb

SSD1306.cpp

@@ -1,48 +1,69 @@
-/**The MIT License (MIT)
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 by Daniel Eichhorn
+ * Copyright (c) 2016 by Fabrice Weinberg
+ *
+ * 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.
+ *
+ * Credits for parts of this code go to Mike Rankin. Thank you so much for sharing!
+ */
 
-Copyright (c) 2015 by Daniel Eichhorn
+#pragma once
 
-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:
+#include <Arduino.h>
+#include <Wire.h>
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+#include "SSD1306Fonts.h"
 
-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.
+//#define DEBUG_SSD1306(...) Serial.printf( __VA_ARGS__ )
 
-See more at http://blog.squix.ch
+#ifndef DEBUG_SSD1306
+#define DEBUG_SSD1306(...)
+#endif
 
-Credits for parts of this code go to Mike Rankin. Thank you so much for sharing!
-*/
-#pragma once
+// Use DOUBLE BUFFERING by default
+#ifndef SSD1306_REDUCE_MEMORY
+#define SSD1306_DOUBLE_BUFFER
+#endif
 
-#include <Arduino.h>
-#include "SSD1306Fonts.h"
 
-#define BLACK 0
-#define WHITE 1
-#define INVERSE 2
+// Display settings
+#define DISPLAY_WIDTH 128
+#define DISPLAY_HEIGHT 64
+#define DISPLAY_BUFFER_SIZE 1024
+
+// Header Values
+#define JUMPTABLE_BYTES 4
+#define JUMPTABLE_LSB   1
+#define JUMPTABLE_SIZE  2
+#define JUMPTABLE_WIDTH 3
+
+#define JUMPTABLE_START 4
 
 #define WIDTH_POS 0
 #define HEIGHT_POS 1
 #define FIRST_CHAR_POS 2
 #define CHAR_NUM_POS 3
-#define CHAR_WIDTH_START_POS 4
 
-#define TEXT_ALIGN_LEFT 0
-#define TEXT_ALIGN_CENTER 1
-#define TEXT_ALIGN_RIGHT 2
 
+// Display commands
 #define CHARGEPUMP 0x8D
 #define COLUMNADDR 0x21
 #define COMSCANDEC 0xC8
@@ -70,104 +91,139 @@ Credits for parts of this code go to Mike Rankin. Thank you so much for sharing!
 #define SETVCOMDETECT 0xDB
 #define SWITCHCAPVCC 0x2
 
+enum SSD1306_COLOR {
+  BLACK = 0,
+  WHITE = 1,
+  INVERSE = 2
+};
+
+enum SSD1306_TEXT_ALIGNMENT {
+  TEXT_ALIGN_LEFT = 0,
+  TEXT_ALIGN_RIGHT = 1,
+  TEXT_ALIGN_CENTER = 2,
+	TEXT_ALIGN_CENTER_BOTH = 3
+};
+
 class SSD1306 {
+  private:
+
+    uint8_t             i2cAddress;
+    uint8_t             sda;
+    uint8_t             sdc;
+
+    uint8_t       		 *buffer;
+
+    #ifdef SSD1306_DOUBLE_BUFFER
+    uint8_t        		 *buffer_back;
+    #endif
+
+    SSD1306_TEXT_ALIGNMENT 	textAlignment = TEXT_ALIGN_LEFT;
+    SSD1306_COLOR  		 			color         = WHITE;
+
+    const char     		 *fontData      = ArialMT_Plain_10;
+
+    // Send a command to the display (low level function)
+    void sendCommand(unsigned char com);
+
+    // Send all the init commands
+    void sendInitCommands(void);
+
+    // converts utf8 characters to extended ascii
+    byte utf8ascii(byte ascii);
+    char* utf8ascii(String s);
+
+    void drawInternal(int16_t xMove, int16_t yMove, int16_t width, int16_t height, const char *data, uint16_t offset, uint16_t bytesInData);
+
+  public:
+
+    // Create the display object connected to pin sda and sdc
+    SSD1306(uint8_t i2cAddress, uint8_t sda, uint8_t sdc);
+
+    // Initialize the display
+    bool init();
 
-private:
-   int myI2cAddress;
-   int mySda;
-   int mySdc;
-   uint8_t buffer[128 * 64 / 8];
-   int myTextAlignment = TEXT_ALIGN_LEFT;
-   int myColor = WHITE;
-   byte lastChar;
-   const char *myFontData = ArialMT_Plain_10;
+    // Free the memory used by the display
+    void end();
 
-public:
-   // Create the display object connected to pin sda and sdc
-   SSD1306(int i2cAddress, int sda, int sdc);
+    // Cycle through the initialization
+    void resetDisplay(void);
 
-   // Initialize the display
-   void init();
+    // Connect again to the display through I2C
+    void reconnect(void);
 
-   // Cycle through the initialization
-   void resetDisplay(void);
+    /* Drawing functions */
 
-   // Connect again to the display through I2C
-   void reconnect(void);
+    // Sets the color of all pixel operations
+    void setColor(SSD1306_COLOR color);
 
-   // Turn the display on
-   void displayOn(void);
+    // Draw a pixel at given position
+    void setPixel(int16_t x, int16_t y);
 
-   // Turn the display offs
-   void displayOff(void);
+    // Draw the border of a rectangle at the given location
+    void drawRect(int16_t x, int16_t y, int16_t width, int16_t height);
 
-   // Clear the local pixel buffer
-   void clear(void);
+    // Fill the rectangle
+    void fillRect(int16_t x, int16_t y, int16_t width, int16_t height);
 
-   // Write the buffer to the display memory
-   void display(void);
+    // Draw a line horizontally
+    void drawHorizontalLine(int16_t x, int16_t y, int16_t length);
 
-   // Set display contrast
-   void setContrast(char contrast);
+    // Draw a lin vertically
+    void drawVerticalLine(int16_t x, int16_t y, int16_t length);
 
-   // Turn the display upside down
-   void flipScreenVertically();
+    // Draw a bitmap in the internal image format
+    void drawFastImage(int16_t x, int16_t y, int16_t width, int16_t height, const char *image);
 
-   // Send a command to the display (low level function)
-   void sendCommand(unsigned char com);
+    // Draw a XBM
+    void drawXbm(int16_t x, int16_t y, int16_t width, int16_t height, const char *xbm);
 
-   // Send all the init commands
-   void sendInitCommands(void);
+    /* Text functions */
 
-   // Draw a pixel at given position
-   void setPixel(int x, int y);
+    // Draws a string at the given location
+    void drawString(int16_t x, int16_t y, String text);
 
-   // Draw 8 bits at the given position
-   void setChar(int x, int y, unsigned char data);
+    // Draws a String with a maximum width at the given location.
+    // If the given String is wider than the specified width
+    // The text will be wrapped to the next line at a space or dash
+    void drawStringMaxWidth(int16_t x, int16_t y, int16_t maxLineWidth, String text);
 
-   // Draw the border of a rectangle at the given location
-   void drawRect(int x, int y, int width, int height);
+    // Returns the width of the String with the current
+    // font settings
+    uint16_t getStringWidth(const char* text);
 
-   // Fill the rectangle
-   void fillRect(int x, int y, int width, int height);
+    // Specifies relative to which anchor point
+    // the text is rendered. Available constants:
+    // TEXT_ALIGN_LEFT, TEXT_ALIGN_CENTER, TEXT_ALIGN_RIGHT, TEXT_ALIGN_CENTER_BOTH
+    void setTextAlignment(SSD1306_TEXT_ALIGNMENT textAlignment);
 
-   // Draw a bitmap with the given dimensions
-   void drawBitmap(int x, int y, int width, int height, const char *bitmap);
+    // Sets the current font. Available default fonts
+    // ArialMT_Plain_10, ArialMT_Plain_16, ArialMT_Plain_24
+    void setFont(const char *fontData);
 
-   // Draw an XBM image with the given dimensions
-   void drawXbm(int x, int y, int width, int height, const char *xbm);
+    /* Display functions */
 
-   // Sets the color of all pixel operations
-   void setColor(int color);
+    // Turn the display on
+    void displayOn(void);
 
-   // converts utf8 characters to extended ascii
-   // taken from http://playground.arduino.cc/Main/Utf8ascii
-   byte utf8ascii(byte ascii);
+    // Turn the display offs
+    void displayOff(void);
 
-   // converts utf8 string to extended ascii
-   // taken from http://playground.arduino.cc/Main/Utf8ascii
-   String utf8ascii(String s);
+    // Inverted display mode
+    void invertDisplay(void);
 
-   // Draws a string at the given location
-   void drawString(int x, int y, String text);
+    // Normal display mode
+    void normalDisplay(void);
 
-   // Draws a String with a maximum width at the given location.
-   // If the given String is wider than the specified width
-   // The text will be wrapped to the next line at a space or dash
-   void drawStringMaxWidth(int x, int y, int maxLineWidth, String text);
+    // Set display contrast
+    void setContrast(char contrast);
 
-   // Returns the width of the String with the current
-   // font settings
-   int getStringWidth(String text);
+    // Turn the display upside down
+    void flipScreenVertically();
 
-   // Specifies relative to which anchor point
-   // the text is rendered. Available constants:
-   // TEXT_ALIGN_LEFT, TEXT_ALIGN_CENTER, TEXT_ALIGN_RIGHT
-   void setTextAlignment(int textAlignment);
+    // Write the buffer to the display memory
+    void display(void);
 
-   // Sets the current font. Available default fonts
-   // defined in SSD1306Fonts.h:
-   // ArialMT_Plain_10, ArialMT_Plain_16, ArialMT_Plain_24
-   void setFont(const char *fontData);
+    // Clear the local pixel buffer
+    void clear(void);
 
-};
+};