Sean Houlihane / Adafruit_GFX_nano

Fork of Adafruit OLED driver to debug integration with RedBear Nano SPI driver

Dependents:   SPI_GFX_nano

Fork of Adafruit_GFX by Neal Horman

Adafruit_SSD1306.h@17:ad8b4fb845ff, 2015-02-25 (annotated)

Committer:
tsh
Date:
Wed Feb 25 20:05:23 2015 +0000
Revision:
17:ad8b4fb845ff
Parent:
15:77feec1c0684
Child:
18:515811a6a589
Add nRF SPI transport

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nkhorman 0:c3dcd4c4983a 1 /*********************************************************************
nkhorman 0:c3dcd4c4983a 2 This is a library for our Monochrome OLEDs based on SSD1306 drivers
nkhorman 0:c3dcd4c4983a 3
nkhorman 0:c3dcd4c4983a 4 Pick one up today in the adafruit shop!
nkhorman 0:c3dcd4c4983a 5 ------> http://www.adafruit.com/category/63_98
nkhorman 0:c3dcd4c4983a 6
nkhorman 0:c3dcd4c4983a 7 These displays use SPI to communicate, 4 or 5 pins are required to
nkhorman 0:c3dcd4c4983a 8 interface
nkhorman 0:c3dcd4c4983a 9
nkhorman 0:c3dcd4c4983a 10 Adafruit invests time and resources providing this open source code,
nkhorman 0:c3dcd4c4983a 11 please support Adafruit and open-source hardware by purchasing
nkhorman 0:c3dcd4c4983a 12 products from Adafruit!
nkhorman 0:c3dcd4c4983a 13
nkhorman 0:c3dcd4c4983a 14 Written by Limor Fried/Ladyada for Adafruit Industries.
nkhorman 0:c3dcd4c4983a 15 BSD license, check license.txt for more information
nkhorman 0:c3dcd4c4983a 16 All text above, and the splash screen must be included in any redistribution
nkhorman 0:c3dcd4c4983a 17 *********************************************************************/
nkhorman 0:c3dcd4c4983a 18
nkhorman 0:c3dcd4c4983a 19 /*
nkhorman 9:ddb97c9850a2 20 * Modified by Neal Horman 7/14/2012 for use in mbed
nkhorman 0:c3dcd4c4983a 21 */
nkhorman 0:c3dcd4c4983a 22
nkhorman 0:c3dcd4c4983a 23 #ifndef _ADAFRUIT_SSD1306_H_
nkhorman 0:c3dcd4c4983a 24 #define _ADAFRUIT_SSD1306_H_
nkhorman 0:c3dcd4c4983a 25
nkhorman 0:c3dcd4c4983a 26 #include "mbed.h"
nkhorman 0:c3dcd4c4983a 27 #include "Adafruit_GFX.h"
tsh 17:ad8b4fb845ff 28 #include "spi_master.h"
nkhorman 0:c3dcd4c4983a 29
nkhorman 9:ddb97c9850a2 30 #include <vector>
nkhorman 9:ddb97c9850a2 31 #include <algorithm>
nkhorman 0:c3dcd4c4983a 32
nkhorman 9:ddb97c9850a2 33 // A DigitalOut sub-class that provides a constructed default state
nkhorman 9:ddb97c9850a2 34 class DigitalOut2 : public DigitalOut
nkhorman 9:ddb97c9850a2 35 {
nkhorman 9:ddb97c9850a2 36 public:
nkhorman 9:ddb97c9850a2 37 DigitalOut2(PinName pin, bool active = false) : DigitalOut(pin) { write(active); };
nkhorman 9:ddb97c9850a2 38 DigitalOut2& operator= (int value) { write(value); return *this; };
nkhorman 9:ddb97c9850a2 39 DigitalOut2& operator= (DigitalOut2& rhs) { write(rhs.read()); return *this; };
nkhorman 9:ddb97c9850a2 40 operator int() { return read(); };
nkhorman 9:ddb97c9850a2 41 };
Neal Horman 6:1be3e3b46eb7 42
nkhorman 0:c3dcd4c4983a 43 #define SSD1306_EXTERNALVCC 0x1
nkhorman 0:c3dcd4c4983a 44 #define SSD1306_SWITCHCAPVCC 0x2
nkhorman 0:c3dcd4c4983a 45
nkhorman 11:86909e6db3c8 46 /** The pure base class for the SSD1306 display driver.
nkhorman 11:86909e6db3c8 47 *
nkhorman 11:86909e6db3c8 48 * You should derive from this for a new transport interface type,
nkhorman 11:86909e6db3c8 49 * such as the SPI and I2C drivers.
nkhorman 11:86909e6db3c8 50 */
nkhorman 0:c3dcd4c4983a 51 class Adafruit_SSD1306 : public Adafruit_GFX
nkhorman 0:c3dcd4c4983a 52 {
nkhorman 9:ddb97c9850a2 53 public:
nkhorman 9:ddb97c9850a2 54 Adafruit_SSD1306(PinName RST, uint8_t rawHeight = 32, uint8_t rawWidth = 128)
nkhorman 9:ddb97c9850a2 55 : Adafruit_GFX(rawWidth,rawHeight)
nkhorman 9:ddb97c9850a2 56 , rst(RST,false)
nkhorman 11:86909e6db3c8 57 {
nkhorman 11:86909e6db3c8 58 buffer.resize(rawHeight * rawWidth / 8);
nkhorman 11:86909e6db3c8 59 };
nkhorman 9:ddb97c9850a2 60
nkhorman 9:ddb97c9850a2 61 void begin(uint8_t switchvcc = SSD1306_SWITCHCAPVCC);
nkhorman 11:86909e6db3c8 62
nkhorman 11:86909e6db3c8 63 // These must be implemented in the derived transport driver
nkhorman 9:ddb97c9850a2 64 virtual void command(uint8_t c) = 0;
nkhorman 9:ddb97c9850a2 65 virtual void data(uint8_t c) = 0;
nkhorman 11:86909e6db3c8 66 virtual void drawPixel(int16_t x, int16_t y, uint16_t color);
nkhorman 11:86909e6db3c8 67
nkhorman 11:86909e6db3c8 68 /// Clear the display buffer
nkhorman 9:ddb97c9850a2 69 void clearDisplay(void);
nkhorman 9:ddb97c9850a2 70 virtual void invertDisplay(bool i);
nkhorman 11:86909e6db3c8 71
nkhorman 11:86909e6db3c8 72 /// Cause the display to be updated with the buffer content.
nkhorman 9:ddb97c9850a2 73 void display();
nkhorman 11:86909e6db3c8 74 /// Fill the buffer with the AdaFruit splash screen.
nkhorman 9:ddb97c9850a2 75 virtual void splash();
nkhorman 9:ddb97c9850a2 76
nkhorman 9:ddb97c9850a2 77 protected:
nkhorman 9:ddb97c9850a2 78 virtual void sendDisplayBuffer() = 0;
nkhorman 9:ddb97c9850a2 79 DigitalOut2 rst;
nkhorman 9:ddb97c9850a2 80
nkhorman 9:ddb97c9850a2 81 // the memory buffer for the LCD
nkhorman 9:ddb97c9850a2 82 std::vector<uint8_t> buffer;
nkhorman 9:ddb97c9850a2 83 };
nkhorman 9:ddb97c9850a2 84
nkhorman 11:86909e6db3c8 85
nkhorman 11:86909e6db3c8 86 /** This is the SPI SSD1306 display driver transport class
nkhorman 11:86909e6db3c8 87 *
nkhorman 11:86909e6db3c8 88 */
nkhorman 9:ddb97c9850a2 89 class Adafruit_SSD1306_Spi : public Adafruit_SSD1306
nkhorman 9:ddb97c9850a2 90 {
nkhorman 9:ddb97c9850a2 91 public:
nkhorman 11:86909e6db3c8 92 /** Create a SSD1306 SPI transport display driver instance with the specified DC, RST, and CS pins, as well as the display dimentions
nkhorman 11:86909e6db3c8 93 *
nkhorman 11:86909e6db3c8 94 * Required parameters
nkhorman 11:86909e6db3c8 95 * @param spi - a reference to an initialized SPI object
nkhorman 11:86909e6db3c8 96 * @param DC (Data/Command) pin name
nkhorman 11:86909e6db3c8 97 * @param RST (Reset) pin name
nkhorman 11:86909e6db3c8 98 * @param CS (Chip Select) pin name
nkhorman 11:86909e6db3c8 99 *
nkhorman 11:86909e6db3c8 100 * Optional parameters
nkhorman 11:86909e6db3c8 101 * @param rawHeight - the vertical number of pixels for the display, defaults to 32
nkhorman 11:86909e6db3c8 102 * @param rawWidth - the horizonal number of pixels for the display, defaults to 128
nkhorman 11:86909e6db3c8 103 */
nkhorman 9:ddb97c9850a2 104 Adafruit_SSD1306_Spi(SPI &spi, PinName DC, PinName RST, PinName CS, uint8_t rawHieght = 32, uint8_t rawWidth = 128)
nkhorman 9:ddb97c9850a2 105 : Adafruit_SSD1306(RST, rawHieght, rawWidth)
nkhorman 9:ddb97c9850a2 106 , cs(CS,true)
nkhorman 9:ddb97c9850a2 107 , dc(DC,false)
nkhorman 9:ddb97c9850a2 108 , mspi(spi)
nkhorman 9:ddb97c9850a2 109 {
nkhorman 9:ddb97c9850a2 110 begin();
nkhorman 9:ddb97c9850a2 111 splash();
nkhorman 9:ddb97c9850a2 112 display();
nkhorman 9:ddb97c9850a2 113 };
nkhorman 9:ddb97c9850a2 114
nkhorman 9:ddb97c9850a2 115 virtual void command(uint8_t c)
nkhorman 9:ddb97c9850a2 116 {
nkhorman 9:ddb97c9850a2 117 cs = 1;
nkhorman 9:ddb97c9850a2 118 dc = 0;
nkhorman 9:ddb97c9850a2 119 cs = 0;
nkhorman 9:ddb97c9850a2 120 mspi.write(c);
nkhorman 9:ddb97c9850a2 121 cs = 1;
nkhorman 9:ddb97c9850a2 122 };
nkhorman 9:ddb97c9850a2 123
nkhorman 9:ddb97c9850a2 124 virtual void data(uint8_t c)
nkhorman 9:ddb97c9850a2 125 {
nkhorman 9:ddb97c9850a2 126 cs = 1;
nkhorman 9:ddb97c9850a2 127 dc = 1;
nkhorman 9:ddb97c9850a2 128 cs = 0;
nkhorman 9:ddb97c9850a2 129 mspi.write(c);
nkhorman 9:ddb97c9850a2 130 cs = 1;
nkhorman 9:ddb97c9850a2 131 };
nkhorman 9:ddb97c9850a2 132
nkhorman 9:ddb97c9850a2 133 protected:
nkhorman 9:ddb97c9850a2 134 virtual void sendDisplayBuffer()
nkhorman 9:ddb97c9850a2 135 {
nkhorman 9:ddb97c9850a2 136 cs = 1;
nkhorman 9:ddb97c9850a2 137 dc = 1;
nkhorman 9:ddb97c9850a2 138 cs = 0;
nkhorman 9:ddb97c9850a2 139
nkhorman 9:ddb97c9850a2 140 for(uint16_t i=0, q=buffer.size(); i<q; i++)
nkhorman 9:ddb97c9850a2 141 mspi.write(buffer[i]);
nkhorman 9:ddb97c9850a2 142
nkhorman 11:86909e6db3c8 143 if(height() == 32)
nkhorman 11:86909e6db3c8 144 {
nkhorman 11:86909e6db3c8 145 for(uint16_t i=0, q=buffer.size(); i<q; i++)
nkhorman 11:86909e6db3c8 146 mspi.write(0);
nkhorman 11:86909e6db3c8 147 }
nkhorman 11:86909e6db3c8 148
nkhorman 9:ddb97c9850a2 149 cs = 1;
nkhorman 9:ddb97c9850a2 150 };
nkhorman 9:ddb97c9850a2 151
nkhorman 9:ddb97c9850a2 152 DigitalOut2 cs, dc;
nkhorman 9:ddb97c9850a2 153 SPI &mspi;
nkhorman 9:ddb97c9850a2 154 };
nkhorman 9:ddb97c9850a2 155
nkhorman 11:86909e6db3c8 156 /** This is the I2C SSD1306 display driver transport class
nkhorman 11:86909e6db3c8 157 *
nkhorman 11:86909e6db3c8 158 */
nkhorman 9:ddb97c9850a2 159 class Adafruit_SSD1306_I2c : public Adafruit_SSD1306
nkhorman 9:ddb97c9850a2 160 {
nkhorman 9:ddb97c9850a2 161 public:
nkhorman 9:ddb97c9850a2 162 #define SSD_I2C_ADDRESS 0x78
nkhorman 11:86909e6db3c8 163 /** Create a SSD1306 I2C transport display driver instance with the specified RST pin name, the I2C address, as well as the display dimensions
nkhorman 11:86909e6db3c8 164 *
nkhorman 11:86909e6db3c8 165 * Required parameters
nkhorman 11:86909e6db3c8 166 * @param i2c - A reference to an initialized I2C object
nkhorman 11:86909e6db3c8 167 * @param RST - The Reset pin name
nkhorman 11:86909e6db3c8 168 *
nkhorman 11:86909e6db3c8 169 * Optional parameters
nkhorman 11:86909e6db3c8 170 * @param i2cAddress - The i2c address of the display
nkhorman 11:86909e6db3c8 171 * @param rawHeight - The vertical number of pixels for the display, defaults to 32
nkhorman 11:86909e6db3c8 172 * @param rawWidth - The horizonal number of pixels for the display, defaults to 128
nkhorman 11:86909e6db3c8 173 */
nkhorman 9:ddb97c9850a2 174 Adafruit_SSD1306_I2c(I2C &i2c, PinName RST, uint8_t i2cAddress = SSD_I2C_ADDRESS, uint8_t rawHeight = 32, uint8_t rawWidth = 128)
nkhorman 9:ddb97c9850a2 175 : Adafruit_SSD1306(RST, rawHeight, rawWidth)
nkhorman 9:ddb97c9850a2 176 , mi2c(i2c)
nkhorman 9:ddb97c9850a2 177 , mi2cAddress(i2cAddress)
nkhorman 9:ddb97c9850a2 178 {
nkhorman 9:ddb97c9850a2 179 begin();
nkhorman 9:ddb97c9850a2 180 splash();
nkhorman 9:ddb97c9850a2 181 display();
nkhorman 9:ddb97c9850a2 182 };
nkhorman 9:ddb97c9850a2 183
nkhorman 9:ddb97c9850a2 184 virtual void command(uint8_t c)
nkhorman 9:ddb97c9850a2 185 {
nkhorman 9:ddb97c9850a2 186 char buff[2];
nkhorman 9:ddb97c9850a2 187 buff[0] = 0; // Command Mode
nkhorman 9:ddb97c9850a2 188 buff[1] = c;
nkhorman 9:ddb97c9850a2 189 mi2c.write(mi2cAddress, buff, sizeof(buff));
nkhorman 9:ddb97c9850a2 190 }
nkhorman 9:ddb97c9850a2 191
nkhorman 9:ddb97c9850a2 192 virtual void data(uint8_t c)
nkhorman 9:ddb97c9850a2 193 {
nkhorman 9:ddb97c9850a2 194 char buff[2];
nkhorman 9:ddb97c9850a2 195 buff[0] = 0x40; // Data Mode
nkhorman 9:ddb97c9850a2 196 buff[1] = c;
nkhorman 9:ddb97c9850a2 197 mi2c.write(mi2cAddress, buff, sizeof(buff));
nkhorman 9:ddb97c9850a2 198 };
nkhorman 9:ddb97c9850a2 199
nkhorman 9:ddb97c9850a2 200 protected:
nkhorman 9:ddb97c9850a2 201 virtual void sendDisplayBuffer()
nkhorman 9:ddb97c9850a2 202 {
nkhorman 9:ddb97c9850a2 203 char buff[17];
nkhorman 9:ddb97c9850a2 204 buff[0] = 0x40; // Data Mode
nkhorman 9:ddb97c9850a2 205
nkhorman 9:ddb97c9850a2 206 // send display buffer in 16 byte chunks
nkhorman 9:ddb97c9850a2 207 for(uint16_t i=0, q=buffer.size(); i<q; i+=16 )
nkhorman 9:ddb97c9850a2 208 { uint8_t x ;
nkhorman 9:ddb97c9850a2 209
nkhorman 9:ddb97c9850a2 210 // TODO - this will segfault if buffer.size() % 16 != 0
nkhorman 9:ddb97c9850a2 211 for(x=1; x<sizeof(buff); x++)
JojoS 15:77feec1c0684 212 buff[x] = buffer[i+x-1];
nkhorman 9:ddb97c9850a2 213 mi2c.write(mi2cAddress, buff, sizeof(buff));
nkhorman 9:ddb97c9850a2 214 }
nkhorman 9:ddb97c9850a2 215 };
nkhorman 9:ddb97c9850a2 216
nkhorman 9:ddb97c9850a2 217 I2C &mi2c;
nkhorman 9:ddb97c9850a2 218 uint8_t mi2cAddress;
nkhorman 0:c3dcd4c4983a 219 };
tsh 17:ad8b4fb845ff 220 /** This is the SPI SSD1306 display driver transport class
tsh 17:ad8b4fb845ff 221 *
tsh 17:ad8b4fb845ff 222 */
tsh 17:ad8b4fb845ff 223 class Adafruit_SSD1306_nrf : public Adafruit_SSD1306
tsh 17:ad8b4fb845ff 224 {
tsh 17:ad8b4fb845ff 225 public:
tsh 17:ad8b4fb845ff 226 /** Create a SSD1306 SPI transport display driver instance with the specified DC, RST, and CS pins, as well as the display dimentions
tsh 17:ad8b4fb845ff 227 *
tsh 17:ad8b4fb845ff 228 * Required parameters
tsh 17:ad8b4fb845ff 229 * @param spi - nRF SPI object
tsh 17:ad8b4fb845ff 230 * @param DC (Data/Command) pin name
tsh 17:ad8b4fb845ff 231 * @param RST (Reset) pin name
tsh 17:ad8b4fb845ff 232 * @param CS (Chip Select) pin name
tsh 17:ad8b4fb845ff 233 *
tsh 17:ad8b4fb845ff 234 * Optional parameters
tsh 17:ad8b4fb845ff 235 * @param rawHeight - the vertical number of pixels for the display, defaults to 32
tsh 17:ad8b4fb845ff 236 * @param rawWidth - the horizonal number of pixels for the display, defaults to 128
tsh 17:ad8b4fb845ff 237 */
tsh 17:ad8b4fb845ff 238 Adafruit_SSD1306_nrf(NRF_SPI_Type *_spi, PinName DC, PinName RST, PinName CS, uint8_t rawHieght = 32, uint8_t rawWidth = 128)
tsh 17:ad8b4fb845ff 239 : Adafruit_SSD1306(RST, rawHieght, rawWidth)
tsh 17:ad8b4fb845ff 240 , cs(CS,true)
tsh 17:ad8b4fb845ff 241 , dc(DC,false)
tsh 17:ad8b4fb845ff 242 , mspi(_spi)
tsh 17:ad8b4fb845ff 243 {
tsh 17:ad8b4fb845ff 244 begin();
tsh 17:ad8b4fb845ff 245 splash();
tsh 17:ad8b4fb845ff 246 display();
tsh 17:ad8b4fb845ff 247 };
nkhorman 0:c3dcd4c4983a 248
tsh 17:ad8b4fb845ff 249 virtual void command(uint8_t c)
tsh 17:ad8b4fb845ff 250 {
tsh 17:ad8b4fb845ff 251 cs = 1;
tsh 17:ad8b4fb845ff 252 dc = 0;
tsh 17:ad8b4fb845ff 253 cs = 0;
tsh 17:ad8b4fb845ff 254 mspi.transfer(c);
tsh 17:ad8b4fb845ff 255 cs = 1;
tsh 17:ad8b4fb845ff 256 };
tsh 17:ad8b4fb845ff 257
tsh 17:ad8b4fb845ff 258 virtual void data(uint8_t c)
tsh 17:ad8b4fb845ff 259 {
tsh 17:ad8b4fb845ff 260 cs = 1;
tsh 17:ad8b4fb845ff 261 dc = 1;
tsh 17:ad8b4fb845ff 262 cs = 0;
tsh 17:ad8b4fb845ff 263 mspi.transfer(c);
tsh 17:ad8b4fb845ff 264 cs = 1;
tsh 17:ad8b4fb845ff 265 };
tsh 17:ad8b4fb845ff 266
tsh 17:ad8b4fb845ff 267 protected:
tsh 17:ad8b4fb845ff 268 virtual void sendDisplayBuffer()
tsh 17:ad8b4fb845ff 269 {
tsh 17:ad8b4fb845ff 270 cs = 1;
tsh 17:ad8b4fb845ff 271 dc = 1;
tsh 17:ad8b4fb845ff 272 cs = 0;
tsh 17:ad8b4fb845ff 273
tsh 17:ad8b4fb845ff 274 for(uint16_t i=0, q=buffer.size(); i<q; i++)
tsh 17:ad8b4fb845ff 275 mspi.transfer(buffer[i]);
tsh 17:ad8b4fb845ff 276
tsh 17:ad8b4fb845ff 277 if(height() == 32)
tsh 17:ad8b4fb845ff 278 {
tsh 17:ad8b4fb845ff 279 for(uint16_t i=0, q=buffer.size(); i<q; i++)
tsh 17:ad8b4fb845ff 280 mspi.transfer(0);
tsh 17:ad8b4fb845ff 281 }
tsh 17:ad8b4fb845ff 282
tsh 17:ad8b4fb845ff 283 cs = 1;
tsh 17:ad8b4fb845ff 284 };
tsh 17:ad8b4fb845ff 285
tsh 17:ad8b4fb845ff 286 DigitalOut2 cs, dc;
tsh 17:ad8b4fb845ff 287 SPIClass mspi;
tsh 17:ad8b4fb845ff 288 };
nkhorman 0:c3dcd4c4983a 289 #endif