uOLED - Heavily documented control library for the uOLED-…

Users » Nakor » Code » uOLED

Heavily documented control library for the uOLED-96-G1 (SGC) by 4D Systems. Will likely work with any of the 4D Systems serial controlled screens. <<info>> All examples in the documentation have been tested to the best of my current abilities, but there are a few functions that I simply do not use. I have created a Lighthouse page for this library. You may submit bug reports or feature requests to [[http://mbed-uoled.lighthouseapp.com|this page]]. If you really do not wish to sign up for a Lighthouse account you may also post any bugs or requests [[/users/Nakor/notebook/uoled-bug-reports/|here]]. <</info>>

Dependents: DS18B20 DS18B20GSM Astromed Astromed_build20121123

uOLED.cpp@12:59da6ae5cfb7, 2010-12-20 (annotated)

Committer:: Nakor
Date:: Mon Dec 20 20:33:36 2010 +0000
Revision:: 12:59da6ae5cfb7
Parent:: 11:1686d4d4bbdb
Child:: 13:f2b9f249bcff

Who changed what in which revision?

User	Revision	Line number	New contents of line
Nakor	0:4f009971ac11	1	#include "uOLED.h"
Nakor	0:4f009971ac11	2	#include "mbed.h"
Nakor	0:4f009971ac11	3
Nakor	0:4f009971ac11	4
Nakor	0:4f009971ac11	5	#define OLED_INITDELAYMS 500
Nakor	0:4f009971ac11	6
Nakor	0:4f009971ac11	7	#define OLED_ACK 0x06 // Ok
Nakor	0:4f009971ac11	8	#define OLED_NAK 0x15 // Error
Nakor	0:4f009971ac11	9
Nakor	0:4f009971ac11	10
Nakor	0:4f009971ac11	11
Nakor	0:4f009971ac11	12	uOLED::uOLED(PinName serialTX, PinName serialRX, PinName reset) :
Nakor	0:4f009971ac11	13	_oled(serialTX, serialRX),
Nakor	0:4f009971ac11	14	_reset(reset) {
Nakor	0:4f009971ac11	15
Nakor	0:4f009971ac11	16	_oled.baud(230400);
Nakor	0:4f009971ac11	17	}
Nakor	0:4f009971ac11	18
Nakor	0:4f009971ac11	19	/******************/
Nakor	0:4f009971ac11	20	/* Protected */
Nakor	0:4f009971ac11	21	/******************/
Nakor	0:4f009971ac11	22	void uOLED::resetDisplay() {
Nakor	0:4f009971ac11	23	_reset = 0;
Nakor	0:4f009971ac11	24	wait_ms(20);
Nakor	0:4f009971ac11	25	_reset = 1;
Nakor	0:4f009971ac11	26	wait_ms(20);
Nakor	0:4f009971ac11	27	}
Nakor	0:4f009971ac11	28
Nakor	0:4f009971ac11	29
Nakor	0:4f009971ac11	30	/******************/
Nakor	0:4f009971ac11	31	/* Public */
Nakor	0:4f009971ac11	32	/******************/
Nakor	0:4f009971ac11	33	short uOLED::getRGB(char red, char green, char blue) {
Nakor	0:4f009971ac11	34	int outR = ((red * 31) / 255);
Nakor	0:4f009971ac11	35	int outG = ((green * 63) / 255);
Nakor	0:4f009971ac11	36	int outB = ((blue * 31) / 255);
Nakor	0:4f009971ac11	37
Nakor	0:4f009971ac11	38	return (outR << 11) \| (outG << 5) \| outB;
Nakor	0:4f009971ac11	39	}
Nakor	0:4f009971ac11	40
Nakor	0:4f009971ac11	41	bool uOLED::addBitmappedCharacter(char character, char data[8]) {
Nakor	0:4f009971ac11	42	_oled.putc(0x41);
Nakor	0:4f009971ac11	43	_oled.putc(character);
Nakor	0:4f009971ac11	44	for (int i=0; i<8; i++) _oled.putc(data[i]);
Nakor	0:4f009971ac11	45	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	46	}
Nakor	0:4f009971ac11	47
Nakor	0:4f009971ac11	48	bool uOLED::blockCopyPaste(char sourceX, char sourceY, char destinationX, char destinationY, char width, char height) {
Nakor	0:4f009971ac11	49	_oled.putc(0x63);
Nakor	0:4f009971ac11	50	_oled.putc(sourceX);
Nakor	0:4f009971ac11	51	_oled.putc(sourceY);
Nakor	0:4f009971ac11	52	_oled.putc(destinationX);
Nakor	0:4f009971ac11	53	_oled.putc(destinationY);
Nakor	0:4f009971ac11	54	_oled.putc(width);
Nakor	0:4f009971ac11	55	_oled.putc(height);
Nakor	0:4f009971ac11	56
Nakor	0:4f009971ac11	57	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	58	}
Nakor	0:4f009971ac11	59
Nakor	0:4f009971ac11	60	bool uOLED::displayControl(char mode) {
Nakor	0:4f009971ac11	61	_oled.putc(0x59);
Nakor	0:4f009971ac11	62	_oled.putc(mode);
Nakor	0:4f009971ac11	63
Nakor	0:4f009971ac11	64	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	65	}
Nakor	0:4f009971ac11	66
Nakor	12:59da6ae5cfb7	67	bool uOLED::setContrast(char contrast) {
Nakor	12:59da6ae5cfb7	68	_oled.putc(0x59);
Nakor	12:59da6ae5cfb7	69	_oled.putc(0x02);
Nakor	12:59da6ae5cfb7	70	_oled.putc(contrast);
Nakor	12:59da6ae5cfb7	71
Nakor	12:59da6ae5cfb7	72	return (_oled.getc() == OLED_ACK);
Nakor	12:59da6ae5cfb7	73	}
Nakor	12:59da6ae5cfb7	74
Nakor	0:4f009971ac11	75	bool uOLED::displayUserBitmappedCharacter(char character, char x, char y, short color) {
Nakor	0:4f009971ac11	76	_oled.putc(0x44);
Nakor	0:4f009971ac11	77	_oled.putc(character);
Nakor	0:4f009971ac11	78	_oled.putc(x);
Nakor	0:4f009971ac11	79	_oled.putc(y);
Nakor	0:4f009971ac11	80	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	81	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	82
Nakor	0:4f009971ac11	83	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	84	}
Nakor	0:4f009971ac11	85
Nakor	0:4f009971ac11	86	bool uOLED::drawCharacter(char character, char column, char row, short color) {
Nakor	0:4f009971ac11	87	_oled.putc(0x54);
Nakor	0:4f009971ac11	88	_oled.putc(character);
Nakor	0:4f009971ac11	89	_oled.putc(column);
Nakor	0:4f009971ac11	90	_oled.putc(row);
Nakor	0:4f009971ac11	91	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	92	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	93
Nakor	0:4f009971ac11	94	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	95	}
Nakor	0:4f009971ac11	96
Nakor	0:4f009971ac11	97	bool uOLED::drawCircle(char x, char y, char radius, short color) {
Nakor	0:4f009971ac11	98	_oled.putc(0x43);
Nakor	0:4f009971ac11	99	_oled.putc(x);
Nakor	0:4f009971ac11	100	_oled.putc(y);
Nakor	0:4f009971ac11	101	_oled.putc(radius);
Nakor	0:4f009971ac11	102	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	103	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	104
Nakor	0:4f009971ac11	105	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	106	}
Nakor	0:4f009971ac11	107
Nakor	0:4f009971ac11	108	bool uOLED::drawImage(char x, char y, char width, char height, char colorMode, char *pixels) {
Nakor	0:4f009971ac11	109	int numberOfBytesPerPixel = 1;
Nakor	0:4f009971ac11	110
Nakor	0:4f009971ac11	111	_oled.putc(0x49);
Nakor	0:4f009971ac11	112	_oled.putc(x);
Nakor	0:4f009971ac11	113	_oled.putc(y);
Nakor	0:4f009971ac11	114	_oled.putc(width);
Nakor	0:4f009971ac11	115	_oled.putc(height);
Nakor	0:4f009971ac11	116	_oled.putc(colorMode);
Nakor	0:4f009971ac11	117
Nakor	0:4f009971ac11	118	if (colorMode == 16) numberOfBytesPerPixel = 2;
Nakor	0:4f009971ac11	119
Nakor	0:4f009971ac11	120	for (int i=0; i<width * height * numberOfBytesPerPixel; i++) {
Nakor	0:4f009971ac11	121	_oled.putc(pixels[i]);
Nakor	0:4f009971ac11	122	}
Nakor	0:4f009971ac11	123
Nakor	0:4f009971ac11	124	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	125	}
Nakor	0:4f009971ac11	126
Nakor	0:4f009971ac11	127	bool uOLED::drawLine(char x1, char y1, char x2, char y2, short color) {
Nakor	0:4f009971ac11	128	_oled.putc(0x4C);
Nakor	0:4f009971ac11	129	_oled.putc(x1);
Nakor	0:4f009971ac11	130	_oled.putc(y1);
Nakor	0:4f009971ac11	131	_oled.putc(x2);
Nakor	0:4f009971ac11	132	_oled.putc(y2);
Nakor	0:4f009971ac11	133	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	134	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	135
Nakor	0:4f009971ac11	136	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	137	}
Nakor	0:4f009971ac11	138
Nakor	0:4f009971ac11	139	bool uOLED::drawPolygon(char vertices, char x, char y, short color) {
Nakor	0:4f009971ac11	140	_oled.putc(0x67);
Nakor	0:4f009971ac11	141	_oled.putc(vertices);
Nakor	0:4f009971ac11	142	for (int i=0; i<vertices; i++) {
Nakor	0:4f009971ac11	143	_oled.putc(x[i]);
Nakor	0:4f009971ac11	144	_oled.putc(y[i]);
Nakor	0:4f009971ac11	145	}
Nakor	0:4f009971ac11	146	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	147	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	148
Nakor	0:4f009971ac11	149	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	150	}
Nakor	0:4f009971ac11	151
Nakor	0:4f009971ac11	152	bool uOLED::drawRectangle(char x, char y, char width, char height, short color) {
Nakor	0:4f009971ac11	153	_oled.putc(0x72);
Nakor	0:4f009971ac11	154	_oled.putc(x);
Nakor	0:4f009971ac11	155	_oled.putc(y);
Nakor	0:4f009971ac11	156	_oled.putc(x + width);
Nakor	0:4f009971ac11	157	_oled.putc(y + height);
Nakor	0:4f009971ac11	158	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	159	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	160
Nakor	0:4f009971ac11	161	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	162	}
Nakor	0:4f009971ac11	163
Nakor	0:4f009971ac11	164	bool uOLED::drawText(char column, char row, char font, short color, char *text) {
Nakor	0:4f009971ac11	165	_oled.putc(0x73);
Nakor	0:4f009971ac11	166	_oled.putc(column);
Nakor	0:4f009971ac11	167	_oled.putc(row);
Nakor	0:4f009971ac11	168	_oled.putc(font);
Nakor	0:4f009971ac11	169	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	170	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	171	for (int i=0 ; i<strlen(text) ; i++) _oled.putc(text[i]);
Nakor	0:4f009971ac11	172	_oled.putc(0x00);
Nakor	0:4f009971ac11	173
Nakor	0:4f009971ac11	174	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	175	}
Nakor	0:4f009971ac11	176
Nakor	0:4f009971ac11	177	bool uOLED::drawTriangle(char x1, char y1, char x2, char y2, char x3, char y3, short color) {
Nakor	0:4f009971ac11	178	_oled.putc(0x47);
Nakor	0:4f009971ac11	179	_oled.putc(x1);
Nakor	0:4f009971ac11	180	_oled.putc(y1);
Nakor	0:4f009971ac11	181	_oled.putc(x2);
Nakor	0:4f009971ac11	182	_oled.putc(y2);
Nakor	0:4f009971ac11	183	_oled.putc(x3);
Nakor	0:4f009971ac11	184	_oled.putc(y3);
Nakor	0:4f009971ac11	185	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	186	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	187
Nakor	0:4f009971ac11	188	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	189	}
Nakor	0:4f009971ac11	190
Nakor	0:4f009971ac11	191	bool uOLED::eraseScreen() {
Nakor	0:4f009971ac11	192	_oled.putc(0x45);
Nakor	0:4f009971ac11	193
Nakor	0:4f009971ac11	194	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	195	}
Nakor	0:4f009971ac11	196
Nakor	0:4f009971ac11	197	bool uOLED::init() {
Nakor	0:4f009971ac11	198	resetDisplay();
Nakor	0:4f009971ac11	199
Nakor	0:4f009971ac11	200	wait_ms(OLED_INITDELAYMS);
Nakor	0:4f009971ac11	201	_oled.putc(0x55);
Nakor	0:4f009971ac11	202
Nakor	0:4f009971ac11	203	_oled.getc();
Nakor	0:4f009971ac11	204
Nakor	0:4f009971ac11	205	_oled.putc(0x4F);
Nakor	0:4f009971ac11	206	_oled.putc(0x01);
Nakor	0:4f009971ac11	207
Nakor	0:4f009971ac11	208	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	209	}
Nakor	0:4f009971ac11	210
Nakor	0:4f009971ac11	211	bool uOLED::penSize(char size) {
Nakor	0:4f009971ac11	212	_oled.putc(0x70);
Nakor	0:4f009971ac11	213	_oled.putc(size);
Nakor	0:4f009971ac11	214
Nakor	0:4f009971ac11	215	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	216	}
Nakor	0:4f009971ac11	217
Nakor	0:4f009971ac11	218	bool uOLED::putPixel(char x, char y, short color) {
Nakor	0:4f009971ac11	219	_oled.putc(0x50);
Nakor	0:4f009971ac11	220	_oled.putc(x);
Nakor	0:4f009971ac11	221	_oled.putc(y);
Nakor	0:4f009971ac11	222
Nakor	0:4f009971ac11	223	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	224	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	225
Nakor	0:4f009971ac11	226	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	227	}
Nakor	0:4f009971ac11	228
Nakor	0:4f009971ac11	229	short uOLED::readPixel(char x, char y) {
Nakor	0:4f009971ac11	230	short returnValue;
Nakor	0:4f009971ac11	231
Nakor	0:4f009971ac11	232	_oled.putc(0x52);
Nakor	0:4f009971ac11	233	_oled.putc(x);
Nakor	0:4f009971ac11	234	_oled.putc(y);
Nakor	0:4f009971ac11	235	returnValue = (_oled.getc() << 8);
Nakor	0:4f009971ac11	236	returnValue += _oled.getc();
Nakor	0:4f009971ac11	237
Nakor	0:4f009971ac11	238	return returnValue;
Nakor	0:4f009971ac11	239	}
Nakor	0:4f009971ac11	240
Nakor	11:1686d4d4bbdb	241	bool uOLED::setBackgroundColor(short color) {
Nakor	10:b9efeb70cce1	242	_oled.putc(0x42);
Nakor	0:4f009971ac11	243
Nakor	11:1686d4d4bbdb	244
Nakor	0:4f009971ac11	245	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	246	_oled.putc(color & 0xFF);
Nakor	11:1686d4d4bbdb	247
Nakor	7:c2fa784eb477	248
Nakor	11:1686d4d4bbdb	249	//_oled.putc(colorA);
Nakor	11:1686d4d4bbdb	250	//_oled.putc(colorB);
Nakor	0:4f009971ac11	251
Nakor	0:4f009971ac11	252	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	253	}
Nakor	0:4f009971ac11	254
Nakor	0:4f009971ac11	255	bool uOLED::setFontSize(char fontType) {
Nakor	0:4f009971ac11	256	_oled.putc(0x46);
Nakor	0:4f009971ac11	257	_oled.putc(fontType);
Nakor	0:4f009971ac11	258
Nakor	0:4f009971ac11	259	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	260	}
Nakor	0:4f009971ac11	261
Nakor	0:4f009971ac11	262	bool uOLED::textButton(char state, char x, char y, short buttonColor, char font, short textColor, char textWidth, char textHeight, char *text) {
Nakor	0:4f009971ac11	263	_oled.putc(0x62);
Nakor	0:4f009971ac11	264	_oled.putc(state);
Nakor	0:4f009971ac11	265	_oled.putc(x);
Nakor	0:4f009971ac11	266	_oled.putc(y);
Nakor	0:4f009971ac11	267	_oled.putc(buttonColor >> 8);
Nakor	0:4f009971ac11	268	_oled.putc(buttonColor & 0xFF);
Nakor	0:4f009971ac11	269	_oled.putc(font);
Nakor	0:4f009971ac11	270	_oled.putc(textColor >> 8);
Nakor	0:4f009971ac11	271	_oled.putc(textColor & 0xFF);
Nakor	0:4f009971ac11	272	_oled.putc(textWidth);
Nakor	0:4f009971ac11	273	_oled.putc(textHeight);
Nakor	0:4f009971ac11	274	for (int i=0 ; i<strlen(text) ; i++) _oled.putc(text[i]);
Nakor	0:4f009971ac11	275	_oled.putc(0x00);
Nakor	0:4f009971ac11	276
Nakor	0:4f009971ac11	277	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	278	}
Nakor	0:4f009971ac11	279
Nakor	0:4f009971ac11	280	bool uOLED::textMode(char mode) {
Nakor	0:4f009971ac11	281	_oled.putc(0x4F);
Nakor	0:4f009971ac11	282	_oled.putc(mode);
Nakor	0:4f009971ac11	283
Nakor	0:4f009971ac11	284	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	285	}
Nakor	0:4f009971ac11	286
Nakor	0:4f009971ac11	287	bool uOLED::versionInfo(bool onScreen, char *info) {
Nakor	0:4f009971ac11	288	_oled.putc(0x56);
Nakor	0:4f009971ac11	289	if (onScreen) {
Nakor	0:4f009971ac11	290	_oled.putc(0x01);
Nakor	0:4f009971ac11	291	} else {
Nakor	0:4f009971ac11	292	_oled.putc(0x00);
Nakor	0:4f009971ac11	293	}
Nakor	0:4f009971ac11	294
Nakor	0:4f009971ac11	295	info[0] = _oled.getc();
Nakor	0:4f009971ac11	296	info[1] = _oled.getc();
Nakor	0:4f009971ac11	297	info[2] = _oled.getc();
Nakor	0:4f009971ac11	298	info[3] = _oled.getc();
Nakor	0:4f009971ac11	299	info[4] = _oled.getc();
Nakor	0:4f009971ac11	300
Nakor	0:4f009971ac11	301	return true;
Nakor	0:4f009971ac11	302	}

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	20 Dec 2010
Imports:	62
Forks:	0
Commits:	32
Dependents:	4
Dependencies:	0
Followers:	3

uOLED.cpp@12:59da6ae5cfb7, 2010-12-20 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning