francesco fantoni
a modified version of N5110 library to be used with freescale boards
N5110.h
- Committer:
- Francesco Fantoni
- Date:
- 2014-05-22
- Revision:
- 7:77bd2c73fe41
- Parent:
- 6:adb79338d40f
File content as of revision 7:77bd2c73fe41:
/**
@file N5110.h
@brief Header file containing member functions and variables
*/
#ifndef N5110_H
#define N5110_H
// Command Bytes - taken from Chris Yan's library
// More information can be found in the display datasheet
// H = 0 - Basic instructions
#define CMD_DC_CLEAR_DISPLAY 0x08
#define CMD_DC_NORMAL_MODE 0x0C
#define CMD_DC_FILL_DISPLAY 0x09
#define CMD_DC_INVERT_VIDEO 0x0D
#define CMD_FS_HORIZONTAL_MODE 0x00
#define CMD_FS_VERTICAL_MODE 0x02
#define CMD_FS_BASIC_MODE 0x00
#define CMD_FS_EXTENDED_MODE 0x01
#define CMD_FS_ACTIVE_MODE 0x00
#define CMD_FS_POWER_DOWN_MODE 0x04
// H = 1 - Extended instructions
#define CMD_TC_TEMP_0 0x04
#define CMD_TC_TEMP_1 0x05
#define CMD_TC_TEMP_2 0x06
#define CMD_TC_TEMP_3 0x07
#define CMD_BI_MUX_24 0x15
#define CMD_BI_MUX_48 0x13
#define CMD_BI_MUX_100 0x10
#define CMD_VOP_6V06 0xB2
#define CMD_VOP_7V38 0xC8
// LCD Characteristics
#define LCD_FREQ 2000000
#define LCD_SPI_MODE 0x01
#define LCD_SPI_BITS 0x08
#define LCD_X_MAX 84
#define LCD_Y_MAX 48
// MATH CONSTANTS
//# define PI 3.14159265358979323846 /* pi */
#include "mbed.h"
#include <math.h>
/**
@brief Simple library for interfacing with Nokia 5110 LCD display (https://www.sparkfun.com/products/10168) using the hardware SPI on the mbed.
@brief The display is powered from a GPIO pin meaning it can be controlled via software. The LED backlight is also software-controllable (via PWM pin).
@brief Can print characters and strings to the display using the included 5x7 font.
@brief The library also implements a screen buffer so that individual pixels on the display (84 x 48) can be set, cleared and read.
@brief Acknowledgements to Chris Yan's Nokia_5110 Library.
@brief Revision 1.0
@author Craig A. Evans
@date January 2014
*
* Example:
* @code
#include "mbed.h"
#include "N5110.h"
// VCC,SCE,RST,D/C,MOSI,SCLK,LED
N5110 lcd(p7,p8,p9,p10,p11,p13,p26);
int main() {
// initialise display
lcd.init();
// print a string in top-left corner
lcd.printString("Hello, World!",0,0);
// move cursor to 4th row
lcd.setXYAddress(0,3);
// print character
lcd.printChar('X');
while(1);
}
* @endcode
*/
class N5110
{
public:
/** Create a N5110 object connected to the specified pins
*
* @param pwr Pin connected to Vcc on the LCD display (pin 1)
* @param sce Pin connected to chip enable (pin 3)
* @param rst Pin connected to reset (pin 4)
* @param dc Pin connected to data/command select (pin 5)
* @param mosi Pin connected to data input (MOSI) (pin 6)
* @param sclk Pin connected to serial clock (SCLK) (pin 7)
* @param led Pin connected to LED backlight (must be PWM) (pin 8)
*
*/
N5110(PinName pwrPin, PinName scePin, PinName rstPin, PinName dcPin, PinName mosiPin, PinName sclkPin, PinName ledPin);
/** Initialise display
*
* Powers up the display and turns on backlight (50% brightness default).
* Sets the display up in horizontal addressing mode and with normal video mode.
*/
void init();
/** Turn off
*
* Powers down the display and turns of the backlight.
* Needs to be reinitialised before being re-used.
*/
void turnOff();
/** Clears
*
* Clears the screen.
*/
void clear();
/** Turn on normal video mode (default)
* Black on white
*/
void normalMode();
/** Turn on inverse video mode (default)
* White on black
*/
void inverseMode();
/** Set Brightness
*
* Sets brightness of LED backlight.
* @param brightness - float in range 0.0 to 1.0
*/
void setBrightness(float brightness);
/** Set XY Address
*
* Sets the X and Y address of where the next data sent to the displa will be written in RAM.
* @param x - the column number (0 to 83) - is automatically incremented after data is written
* @param y - the row number (0 to 5) - the diplay is split into 6 banks - each bank can be considered a row
*/
void setXYAddress(int x, int y);
/** Print String
*
* Prints a string of characters to the display.
* @param x - the column number (0 to 83)
* @param y - the row number (0 to 5) - the display is split into 6 banks - each bank can be considered a row
*/
void printString(const char * str,int x,int y);
void printNegString(const char * str,int x,int y);
/** Print Character
*
* Sends a character to the display. Will be printed at the current address.
* X address is autoincremented by 1 to leave a pixel between successive characters.
* @param c - the character to print. Can print ASCII as so printChar('C').
*/
void printChar(char c);
void printNegChar(char c);
/** Set a Pixel
*
* This function sets a pixel in the display. A call to refresh() must be made
* to update the display to reflect the change in pixels.
* @param x - the x co-ordinate of the pixel (0 to 83)
* @param y - the y co-ordinate of the pixel (0 to 47)
*/
void setPixel(int x, int y);
/** Clear a Pixel
*
* This function clears pixel in the display. A call to refresh() must be made
* to update the display to reflect the change in pixels.
* @param x - the x co-ordinate of the pixel (0 to 83)
* @param y - the y co-ordinate of the pixel (0 to 47)
*/
void drawHline(int x, int y, int l);
void drawVline(int x, int y, int l);
void drawRectangle(int x, int y, int w, int h);
void drawGrid(int stepx, int stepy);
void drawLine(int x0, int y0, int x1, int y1);
void drawLineAngle(int x0, int y0, int l, float angle);
void drawCircle(int x, int y, int radius, int divisions);
void clearPixel(int x, int y);
/** Get a Pixel
*
* This function gets the status of a pixel in the display.
* @param x - the x co-ordinate of the pixel (0 to 83)
* @param y - the y co-ordinate of the pixel (0 to 47)
* @returns
* 0 - pixel is clear
* non-zero - pixel is set
*/
unsigned char getPixel(int x, int y);
/** Refresh display
*
* This functions refreshes the display to reflect the current data in the buffer.
*/
void refresh();
/** Randomise buffer
*
* This function fills the buffer with random data. Can be used to test the display.
* A call to refresh() must be made to update the display to reflect the change in pixels.
* The seed is not set and so the generated pattern will probably be the same each time.
* TODO: Randomise the seed - maybe using the noise on the AnalogIn pins.
*/
void randomiseBuffer();
private:
void turnOn();
void reset();
void clearRAM();
void clearBuffer();
void sendCommand(unsigned char command);
void sendData(unsigned char data);
public:
unsigned char buffer[84][6]; // screen buffer - the 6 is for the banks - each one is 8 bits;
int W;
int H;
private: // private variables
SPI* spi;
PwmOut* led;
DigitalOut* pwr;
DigitalOut* sce;
DigitalOut* rst;
DigitalOut* dc;
};
const unsigned char font5x7[480] = {
0x00, 0x00, 0x00, 0x00, 0x00,// (space)
0x00, 0x00, 0x5F, 0x00, 0x00,// !
0x00, 0x07, 0x00, 0x07, 0x00,// "
0x14, 0x7F, 0x14, 0x7F, 0x14,// #
0x24, 0x2A, 0x7F, 0x2A, 0x12,// $
0x23, 0x13, 0x08, 0x64, 0x62,// %
0x36, 0x49, 0x55, 0x22, 0x50,// &
0x00, 0x05, 0x03, 0x00, 0x00,// '
0x00, 0x1C, 0x22, 0x41, 0x00,// (
0x00, 0x41, 0x22, 0x1C, 0x00,// )
0x08, 0x2A, 0x1C, 0x2A, 0x08,// *
0x08, 0x08, 0x3E, 0x08, 0x08,// +
0x00, 0x50, 0x30, 0x00, 0x00,// ,
0x08, 0x08, 0x08, 0x08, 0x08,// -
0x00, 0x60, 0x60, 0x00, 0x00,// .
0x20, 0x10, 0x08, 0x04, 0x02,// /
0x3E, 0x51, 0x49, 0x45, 0x3E,// 0
0x00, 0x42, 0x7F, 0x40, 0x00,// 1
0x42, 0x61, 0x51, 0x49, 0x46,// 2
0x21, 0x41, 0x45, 0x4B, 0x31,// 3
0x18, 0x14, 0x12, 0x7F, 0x10,// 4
0x27, 0x45, 0x45, 0x45, 0x39,// 5
0x3C, 0x4A, 0x49, 0x49, 0x30,// 6
0x01, 0x71, 0x09, 0x05, 0x03,// 7
0x36, 0x49, 0x49, 0x49, 0x36,// 8
0x06, 0x49, 0x49, 0x29, 0x1E,// 9
0x00, 0x36, 0x36, 0x00, 0x00,// :
0x00, 0x56, 0x36, 0x00, 0x00,// ;
0x00, 0x08, 0x14, 0x22, 0x41,// <
0x14, 0x14, 0x14, 0x14, 0x14,// =
0x41, 0x22, 0x14, 0x08, 0x00,// >
0x02, 0x01, 0x51, 0x09, 0x06,// ?
0x32, 0x49, 0x79, 0x41, 0x3E,// @
0x7E, 0x11, 0x11, 0x11, 0x7E,// A
0x7F, 0x49, 0x49, 0x49, 0x36,// B
0x3E, 0x41, 0x41, 0x41, 0x22,// C
0x7F, 0x41, 0x41, 0x22, 0x1C,// D
0x7F, 0x49, 0x49, 0x49, 0x41,// E
0x7F, 0x09, 0x09, 0x01, 0x01,// F
0x3E, 0x41, 0x41, 0x51, 0x32,// G
0x7F, 0x08, 0x08, 0x08, 0x7F,// H
0x00, 0x41, 0x7F, 0x41, 0x00,// I
0x20, 0x40, 0x41, 0x3F, 0x01,// J
0x7F, 0x08, 0x14, 0x22, 0x41,// K
0x7F, 0x40, 0x40, 0x40, 0x40,// L
0x7F, 0x02, 0x04, 0x02, 0x7F,// M
0x7F, 0x04, 0x08, 0x10, 0x7F,// N
0x3E, 0x41, 0x41, 0x41, 0x3E,// O
0x7F, 0x09, 0x09, 0x09, 0x06,// P
0x3E, 0x41, 0x51, 0x21, 0x5E,// Q
0x7F, 0x09, 0x19, 0x29, 0x46,// R
0x46, 0x49, 0x49, 0x49, 0x31,// S
0x01, 0x01, 0x7F, 0x01, 0x01,// T
0x3F, 0x40, 0x40, 0x40, 0x3F,// U
0x1F, 0x20, 0x40, 0x20, 0x1F,// V
0x7F, 0x20, 0x18, 0x20, 0x7F,// W
0x63, 0x14, 0x08, 0x14, 0x63,// X
0x03, 0x04, 0x78, 0x04, 0x03,// Y
0x61, 0x51, 0x49, 0x45, 0x43,// Z
0x00, 0x00, 0x7F, 0x41, 0x41,// [
0x02, 0x04, 0x08, 0x10, 0x20,// "\"
0x41, 0x41, 0x7F, 0x00, 0x00,// ]
0x04, 0x02, 0x01, 0x02, 0x04,// ^
0x40, 0x40, 0x40, 0x40, 0x40,// _
0x00, 0x01, 0x02, 0x04, 0x00,// `
0x20, 0x54, 0x54, 0x54, 0x78,// a
0x7F, 0x48, 0x44, 0x44, 0x38,// b
0x38, 0x44, 0x44, 0x44, 0x20,// c
0x38, 0x44, 0x44, 0x48, 0x7F,// d
0x38, 0x54, 0x54, 0x54, 0x18,// e
0x08, 0x7E, 0x09, 0x01, 0x02,// f
0x08, 0x14, 0x54, 0x54, 0x3C,// g
0x7F, 0x08, 0x04, 0x04, 0x78,// h
0x00, 0x44, 0x7D, 0x40, 0x00,// i
0x20, 0x40, 0x44, 0x3D, 0x00,// j
0x00, 0x7F, 0x10, 0x28, 0x44,// k
0x00, 0x41, 0x7F, 0x40, 0x00,// l
0x7C, 0x04, 0x18, 0x04, 0x78,// m
0x7C, 0x08, 0x04, 0x04, 0x78,// n
0x38, 0x44, 0x44, 0x44, 0x38,// o
0x7C, 0x14, 0x14, 0x14, 0x08,// p
0x08, 0x14, 0x14, 0x18, 0x7C,// q
0x7C, 0x08, 0x04, 0x04, 0x08,// r
0x48, 0x54, 0x54, 0x54, 0x20,// s
0x04, 0x3F, 0x44, 0x40, 0x20,// t
0x3C, 0x40, 0x40, 0x20, 0x7C,// u
0x1C, 0x20, 0x40, 0x20, 0x1C,// v
0x3C, 0x40, 0x30, 0x40, 0x3C,// w
0x44, 0x28, 0x10, 0x28, 0x44,// x
0x0C, 0x50, 0x50, 0x50, 0x3C,// y
0x44, 0x64, 0x54, 0x4C, 0x44,// z
0x00, 0x08, 0x36, 0x41, 0x00,// {
0x00, 0x00, 0x7F, 0x00, 0x00,// |
0x00, 0x41, 0x36, 0x08, 0x00,// }
0x08, 0x08, 0x2A, 0x1C, 0x08,// ->
0x08, 0x1C, 0x2A, 0x08, 0x08 // <-
};
const unsigned char font6x7[576] = {
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // Code for char space
0x00, 0x2E, 0x00, 0x00, 0x00, 0x00, // Code for char !
0x06, 0x00, 0x06, 0x00, 0x00, 0x00, // Code for char "
0x14, 0x3E, 0x14, 0x3E, 0x14, 0x00, // Code for char #
0x2E, 0x2A, 0x3E, 0x2A, 0x3A, 0x00, // Code for char $
0x26, 0x16, 0x08, 0x34, 0x32, 0x00, // Code for char %
0x36, 0x2A, 0x2A, 0x36, 0x10, 0x28, // Code for char &
0x06, 0x00, 0x00, 0x00, 0x00, 0x00, // Code for char '
0x1C, 0x22, 0x00, 0x00, 0x00, 0x00, // Code for char (
0x22, 0x1C, 0x00, 0x00, 0x00, 0x00, // Code for char )
0x0A, 0x04, 0x0A, 0x00, 0x00, 0x00, // Code for char *
0x08, 0x08, 0x3E, 0x08, 0x08, 0x00, // Code for char +
0x30, 0x00, 0x00, 0x00, 0x00, 0x00, // Code for char ,
0x08, 0x08, 0x08, 0x08, 0x08, 0x00, // Code for char -
0x20, 0x00, 0x00, 0x00, 0x00, 0x00, // Code for char .
0x20, 0x10, 0x08, 0x04, 0x02, 0x00, // Code for char /
0x1C, 0x22, 0x22, 0x22, 0x1C, 0x00, // Code for char 0
0x22, 0x3E, 0x20, 0x00, 0x00, 0x00, // Code for char 1
0x3A, 0x2A, 0x2A, 0x2A, 0x2E, 0x00, // Code for char 2
0x2A, 0x2A, 0x2A, 0x2A, 0x3E, 0x00, // Code for char 3
0x18, 0x14, 0x12, 0x3E, 0x10, 0x00, // Code for char 4
0x2E, 0x2A, 0x2A, 0x2A, 0x3A, 0x00, // Code for char 5
0x3E, 0x2A, 0x2A, 0x2A, 0x3A, 0x00, // Code for char 6
0x02, 0x22, 0x12, 0x0A, 0x06, 0x00, // Code for char 7
0x3E, 0x2A, 0x2A, 0x2A, 0x3E, 0x00, // Code for char 8
0x2E, 0x2A, 0x2A, 0x2A, 0x3E, 0x00, // Code for char 9
0x14, 0x00, 0x00, 0x00, 0x00, 0x00, // Code for char :
0x34, 0x00, 0x00, 0x00, 0x00, 0x00, // Code for char ;
0x08, 0x14, 0x22, 0x00, 0x00, 0x00, // Code for char <
0x14, 0x14, 0x14, 0x14, 0x14, 0x00, // Code for char =
0x22, 0x14, 0x08, 0x00, 0x00, 0x00, // Code for char >
0x02, 0x02, 0x2A, 0x0A, 0x0E, 0x00, // Code for char ?
0x3E, 0x22, 0x3A, 0x2A, 0x3E, 0x00, // Code for char @
0x3E, 0x0A, 0x0A, 0x0A, 0x3E, 0x00, // Code for char A
0x3E, 0x2A, 0x2A, 0x2A, 0x1C, 0x00, // Code for char B
0x3E, 0x22, 0x22, 0x22, 0x22, 0x00, // Code for char C
0x3E, 0x22, 0x22, 0x22, 0x1C, 0x00, // Code for char D
0x3E, 0x2A, 0x2A, 0x2A, 0x2A, 0x00, // Code for char E
0x3E, 0x0A, 0x0A, 0x0A, 0x0A, 0x00, // Code for char F
0x3E, 0x22, 0x2A, 0x2A, 0x3A, 0x00, // Code for char G
0x3E, 0x08, 0x08, 0x08, 0x3E, 0x00, // Code for char H
0x22, 0x3E, 0x22, 0x00, 0x00, 0x00, // Code for char I
0x10, 0x20, 0x22, 0x22, 0x1E, 0x00, // Code for char J
0x3E, 0x08, 0x08, 0x14, 0x22, 0x00, // Code for char K
0x3E, 0x20, 0x20, 0x20, 0x20, 0x00, // Code for char L
0x3E, 0x04, 0x08, 0x04, 0x3E, 0x00, // Code for char M
0x3E, 0x04, 0x08, 0x10, 0x3E, 0x00, // Code for char N
0x3E, 0x22, 0x22, 0x22, 0x3E, 0x00, // Code for char O
0x3E, 0x0A, 0x0A, 0x0A, 0x0E, 0x00, // Code for char P
0x3E, 0x22, 0x22, 0x32, 0x3E, 0x00, // Code for char Q
0x3E, 0x0A, 0x0A, 0x3A, 0x2E, 0x00, // Code for char R
0x2E, 0x2A, 0x2A, 0x2A, 0x3A, 0x00, // Code for char S
0x02, 0x02, 0x3E, 0x02, 0x02, 0x00, // Code for char T
0x3E, 0x20, 0x20, 0x20, 0x3E, 0x00, // Code for char U
0x0E, 0x10, 0x20, 0x10, 0x0E, 0x00, // Code for char V
0x1E, 0x20, 0x1E, 0x20, 0x1E, 0x00, // Code for char W
0x22, 0x14, 0x08, 0x14, 0x22, 0x00, // Code for char X
0x06, 0x08, 0x30, 0x08, 0x06, 0x00, // Code for char Y
0x22, 0x32, 0x2A, 0x26, 0x22, 0x00, // Code for char Z
0x3E, 0x22, 0x00, 0x00, 0x00, 0x00, // Code for char [
0x02, 0x04, 0x08, 0x10, 0x20, 0x00, // Code for char BackSlash
0x22, 0x3E, 0x00, 0x00, 0x00, 0x00, // Code for char ]
0x04, 0x02, 0x04, 0x00, 0x00, 0x00, // Code for char ^
0x20, 0x20, 0x20, 0x20, 0x20, 0x00, // Code for char _
0x02, 0x04, 0x00, 0x00, 0x00, 0x00, // Code for char `
0x3E, 0x0A, 0x0A, 0x0A, 0x3E, 0x00, // Code for char a
0x3E, 0x2A, 0x2A, 0x2A, 0x1C, 0x00, // Code for char b
0x3E, 0x22, 0x22, 0x22, 0x22, 0x00, // Code for char c
0x3E, 0x22, 0x22, 0x22, 0x1C, 0x00, // Code for char d
0x3E, 0x2A, 0x2A, 0x2A, 0x2A, 0x00, // Code for char e
0x3E, 0x0A, 0x0A, 0x0A, 0x0A, 0x00, // Code for char f
0x3E, 0x22, 0x2A, 0x2A, 0x3A, 0x00, // Code for char g
0x3E, 0x08, 0x08, 0x08, 0x3E, 0x00, // Code for char h
0x22, 0x3E, 0x22, 0x00, 0x00, 0x00, // Code for char i
0x10, 0x20, 0x22, 0x22, 0x1E, 0x00, // Code for char j
0x3E, 0x08, 0x08, 0x14, 0x22, 0x00, // Code for char k
0x3E, 0x20, 0x20, 0x20, 0x20, 0x00, // Code for char l
0x3E, 0x04, 0x08, 0x04, 0x3E, 0x00, // Code for char m
0x3E, 0x04, 0x08, 0x10, 0x3E, 0x00, // Code for char n
0x3E, 0x22, 0x22, 0x22, 0x3E, 0x00, // Code for char o
0x3E, 0x0A, 0x0A, 0x0A, 0x0E, 0x00, // Code for char p
0x3E, 0x22, 0x22, 0x32, 0x3E, 0x00, // Code for char q
0x3E, 0x0A, 0x0A, 0x3A, 0x2E, 0x00, // Code for char r
0x2E, 0x2A, 0x2A, 0x2A, 0x3A, 0x00, // Code for char s
0x02, 0x02, 0x3E, 0x02, 0x02, 0x00, // Code for char t
0x3E, 0x20, 0x20, 0x20, 0x3E, 0x00, // Code for char u
0x0E, 0x10, 0x20, 0x10, 0x0E, 0x00, // Code for char v
0x1E, 0x20, 0x1E, 0x20, 0x1E, 0x00, // Code for char w
0x22, 0x14, 0x08, 0x14, 0x22, 0x00, // Code for char x
0x06, 0x08, 0x30, 0x08, 0x06, 0x00, // Code for char y
0x22, 0x32, 0x2A, 0x26, 0x22, 0x00, // Code for char z
0x08, 0x36, 0x22, 0x00, 0x00, 0x00, // Code for char {
0x3E, 0x00, 0x00, 0x00, 0x00, 0x00, // Code for char |
0x22, 0x36, 0x08, 0x00, 0x00, 0x00, // Code for char }
0x04, 0x02, 0x04, 0x02, 0x00, 0x00, // Code for char ~
0x3F, 0x21, 0x3F, 0x00, 0x00, 0x00 // Code for char
};
#endif