oledc_.h

Go to the documentation of this file.

/*
 * @file oledc_.h
 *
 * @author Matthew Matz
 *
 * @version 0.9
 *
 * @copyright Copyright (C) Parallax, Inc. 2016.  See end of file for
 * terms of use (MIT License).
 *
 * @brief 0.96-inch RGB OLED driver source header file.
 *
 * @detail Please submit bug reports, suggestions, and improvements to
 * this code to editor@parallax.com.
 */

#ifndef OLEDC_H                               // Prevents duplicate
#define OLEDC_H                               // declarations

#if defined(__cplusplus)                      // If compiling for C++
extern "C" {                                  // Compile for C
#endif


#include <propeller.h>

#define WHITE                     0xFFFF
#define PINK                      0xFD59
#define MAGENTA                   0xF319
#define RED                       0xC082
#define DARKRED                   0xA162
#define REDORANGE                 0xD261
#define LIGHTORANGE               0xFEB6
#define ORANGE                    0xFC00
#define YELLOWORANGE              0xFCC0
#define GOLD                      0xF704
#define YELLOW                    0xF744
#define LEMON                     0xF7D3
#define YELLOWGREEN               0x5600
#define GREEN                     0x1C62
#define DARKGREEN                 0x03CE
#define GREENBLUE                 0x0C75
#define CYAN                      0x5E97
#define LIGHTBLUE                 0x857B
#define SKYBLUE                   0x0E3E
#define BLUE                      0x2B16
#define NAVYBLUE                  0x0007
#define VIOLET                    0x7A37
#define PURPLE                    0x7A37
#define RASPBERRY                 0xA82E
#define TAN                       0xCC2A
#define LIGHTBROWN                0xBB44
#define BRONZE                    0xA440
#define BROWN                     0x9201
#define DARKBROWN                 0x7269
#define LIGHTGRAY                 0xBDD7
#define GRAY                      0x8410
#define DARKGRAY                  0x3186
#define BLACK                     0x0000


#define SMALL    1
#define MEDIUM   2
#define LARGE    3



void oledc_init(char CS, char RS, char SID, char SCLK, char RST, char screen_rotation);

unsigned int oledc_color565(char r, char g, char b);

//
// @name Individual setup calls
// @{
//

//
// @}
//
// @name Drawing Functions
// @{

void oledc_drawPixel(int x, int y, unsigned int color);

void oledc_drawLine(int x0, int y0, int x1, int y1, unsigned int color);

void oledc_drawFastVLine(int x, int y, int h, unsigned int color);

void oledc_drawFastHLine(int x, int y, int w, unsigned int color);

void oledc_drawCircle(int x0, int y0, int r, unsigned int color);

void oledc_fillCircle(int x0, int y0, int r, unsigned int color);

void oledc_drawRect(int x, int y, int w, int h, unsigned int color);

void oledc_fillRect(int x, int y, int w, int h, unsigned int color);

void oledc_drawRoundRect(int x, int y, int w, int h, int r, unsigned int color);

void oledc_fillRoundRect(int x, int y, int w, int h, int r, unsigned int color);

void oledc_drawTriangle(int x0, int y0, int x1, int y1, int x2, int y2, unsigned int color);

void oledc_fillTriangle(int x0, int y0, int x1, int y1, int x2, int y2, unsigned int color);

void oledc_bitmap(char *imgdir, int x0, int y0);

// @}
// @Name Text Functions
// @{

void oledc_setTextSize(char s);

void oledc_setTextColor(unsigned int c, unsigned int b);

void oledc_setTextWrap(char w);

void oledc_setCursor(int x, int y, char size);

int  oledc_print(const char *fmt, ...);

int  oledc_getCursorX();

int  oledc_getCursorY();

// @}
// @Name Screen Manipulation Functions
// @{

void oledc_clear(int x0, int y0, int w, int h);

void oledc_copy(int x0, int y0, int w, int h, int x2, int y2);

char oledc_getRotation();

void oledc_setRotation(char x);

int  oledc_getWidth();

int  oledc_getHeight();

void oledc_invertDisplay();

void oledc_scrollStart(char h, char v); 

void oledc_scrollStop(); 

int  oledc_isScrolling();

// @}
  


#ifndef DOXYGEN_SHOULD_SKIP_THIS

/* =========================================================================== */
//                        PRIVATE FUNCTIONS/MACROS
/* =========================================================================== */

#define gfx_swap(a, b) { unsigned int t = a; a = b; b = t; }
#define absv(x) ((x)<0 ? -(x) : (x))

// Timing Delays
#define SSD1331_DELAYS_HWFILL         25
#define SSD1331_DELAYS_HWLINE         10
#define SSD1331_DELAYS_HWPIXEL        10

// SSD1331 Commands
#define SSD1331_CMD_DRAWLINE        0x21
#define SSD1331_CMD_DRAWRECT        0x22
#define SSD1331_CMD_COPY            0x23
#define SSD1331_CMD_CLEAR           0x25
#define SSD1331_CMD_FILL            0x26
#define SSD1331_CMD_SCROLLSETUP     0x27
#define SSD1331_CMD_SCROLLSTOP      0x2E
#define SSD1331_CMD_SCROLLSTART     0x2F
#define SSD1331_CMD_SETCOLUMN       0x15
#define SSD1331_CMD_SETROW          0x75
#define SSD1331_CMD_CONTRASTA       0x81
#define SSD1331_CMD_CONTRASTB       0x82
#define SSD1331_CMD_CONTRASTC       0x83
#define SSD1331_CMD_MASTERCURRENT   0x87
#define SSD1331_CMD_SETREMAP        0xA0
#define SSD1331_CMD_STARTLINE       0xA1
#define SSD1331_CMD_DISPLAYOFFSET   0xA2
#define SSD1331_CMD_NORMALDISPLAY   0xA4
#define SSD1331_CMD_DISPLAYALLON    0xA5
#define SSD1331_CMD_DISPLAYALLOFF   0xA6
#define SSD1331_CMD_INVERTDISPLAY   0xA7
#define SSD1331_CMD_SETMULTIPLEX    0xA8
#define SSD1331_CMD_SETMASTER       0xAD
#define SSD1331_CMD_DISPLAYOFF      0xAE
#define SSD1331_CMD_DISPLAYON       0xAF
#define SSD1331_CMD_POWERMODE       0xB0
#define SSD1331_CMD_PRECHARGE       0xB1
#define SSD1331_CMD_CLOCKDIV        0xB3
#define SSD1331_CMD_PRECHARGEA      0x8A
#define SSD1331_CMD_PRECHARGEB      0x8B
#define SSD1331_CMD_PRECHARGEC      0x8C
#define SSD1331_CMD_PRECHARGELEVEL  0xBB
#define SSD1331_CMD_VCOMH           0xBE

#define TFTWIDTH  96
#define TFTHEIGHT 64

extern char font_lg_index[95];
extern char font_lg_zeroMap[658];
extern char oled_font_lg[3100];
extern char oled_font_med[2090];

void oledc_spiWrite(char c);

void oledc_writeData(char d);

void oledc_writeCommand(char c);

void oledc_write(char c);

void oledc_drawCharSmall(int x, int y, unsigned char c, unsigned int color, unsigned int bg);

void oledc_drawCharMedium(int x, int y, unsigned char c, unsigned int color, unsigned int bg);

void oledc_drawCharLarge(int x, int y, unsigned char c, unsigned int color, unsigned int bg);

void oledc_goTo(int x, int y);

void oledc_drawCircleHelper( int x0, int y0, int r, char cornername, unsigned int color);

void oledc_fillCircleHelper(int x0, int y0, int r, char cornername, int delta, unsigned int color);


#endif // DOXYGEN_SHOULD_SKIP_THIS


#if defined(__cplusplus)                     
}                                             // End compile for C block
#endif
/* __cplusplus */

#endif                                        // End prevent duplicate forward
/* OLEDC_H */                                 // declarations block    



// Parts of this file are from the Adafruit GFX arduino library

/***************************************************
  This is a library for the 0.96" 16-bit Color OLED with SSD1331 driver chip
  Pick one up today in the adafruit shop!
  ------> http://www.adafruit.com/products/684
  These displays use SPI to communicate, 4 or 5 pins are required to
  interface
  Adafruit invests time and resources providing this open source code,
  please support Adafruit and open-source hardware by purchasing
  products from Adafruit!
  Written by Limor Fried/Ladyada for Adafruit Industries.
  BSD license, all text above must be included in any redistribution
 ****************************************************/