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@22:66401b612b1b, 2010-12-26 (annotated)

Committer:: Nakor
Date:: Sun Dec 26 19:25:23 2010 +0000
Revision:: 22:66401b612b1b
Parent:: 21:87a2227c1ad2
Child:: 25:caf134ebfc34

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	17:cee1c66b3133	60	bool uOLED::displayControl(char mode, char value) {
Nakor	0:4f009971ac11	61	_oled.putc(0x59);
Nakor	0:4f009971ac11	62	_oled.putc(mode);
Nakor	17:cee1c66b3133	63	_oled.putc(value);
Nakor	0:4f009971ac11	64
Nakor	0:4f009971ac11	65	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	66	}
Nakor	0:4f009971ac11	67
Nakor	0:4f009971ac11	68	bool uOLED::displayUserBitmappedCharacter(char character, char x, char y, short color) {
Nakor	0:4f009971ac11	69	_oled.putc(0x44);
Nakor	0:4f009971ac11	70	_oled.putc(character);
Nakor	0:4f009971ac11	71	_oled.putc(x);
Nakor	0:4f009971ac11	72	_oled.putc(y);
Nakor	0:4f009971ac11	73	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	74	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	75
Nakor	0:4f009971ac11	76	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	77	}
Nakor	0:4f009971ac11	78
Nakor	0:4f009971ac11	79	bool uOLED::drawCharacter(char character, char column, char row, short color) {
Nakor	0:4f009971ac11	80	_oled.putc(0x54);
Nakor	0:4f009971ac11	81	_oled.putc(character);
Nakor	0:4f009971ac11	82	_oled.putc(column);
Nakor	0:4f009971ac11	83	_oled.putc(row);
Nakor	0:4f009971ac11	84	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	85	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	86
Nakor	0:4f009971ac11	87	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	88	}
Nakor	0:4f009971ac11	89
Nakor	19:cc4f5d01f080	90	bool uOLED::drawCircle(char x, char y, char radius, short red, short green, short blue)
Nakor	19:cc4f5d01f080	91	{
Nakor	19:cc4f5d01f080	92	short color = getRGB(red, green, blue);
Nakor	19:cc4f5d01f080	93
Nakor	0:4f009971ac11	94	_oled.putc(0x43);
Nakor	0:4f009971ac11	95	_oled.putc(x);
Nakor	0:4f009971ac11	96	_oled.putc(y);
Nakor	0:4f009971ac11	97	_oled.putc(radius);
Nakor	0:4f009971ac11	98	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	99	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	100
Nakor	0:4f009971ac11	101	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	102	}
Nakor	0:4f009971ac11	103
Nakor	0:4f009971ac11	104	bool uOLED::drawImage(char x, char y, char width, char height, char colorMode, char *pixels) {
Nakor	0:4f009971ac11	105	int numberOfBytesPerPixel = 1;
Nakor	0:4f009971ac11	106
Nakor	0:4f009971ac11	107	_oled.putc(0x49);
Nakor	0:4f009971ac11	108	_oled.putc(x);
Nakor	0:4f009971ac11	109	_oled.putc(y);
Nakor	0:4f009971ac11	110	_oled.putc(width);
Nakor	0:4f009971ac11	111	_oled.putc(height);
Nakor	0:4f009971ac11	112	_oled.putc(colorMode);
Nakor	0:4f009971ac11	113
Nakor	0:4f009971ac11	114	if (colorMode == 16) numberOfBytesPerPixel = 2;
Nakor	0:4f009971ac11	115
Nakor	0:4f009971ac11	116	for (int i=0; i<width * height * numberOfBytesPerPixel; i++) {
Nakor	0:4f009971ac11	117	_oled.putc(pixels[i]);
Nakor	0:4f009971ac11	118	}
Nakor	0:4f009971ac11	119
Nakor	0:4f009971ac11	120	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	121	}
Nakor	0:4f009971ac11	122
Nakor	19:cc4f5d01f080	123	bool uOLED::drawLine(char x1, char y1, char x2, char y2, short red, short green, short blue)
Nakor	19:cc4f5d01f080	124	{
Nakor	19:cc4f5d01f080	125	short color = getRGB(red, green, blue);
Nakor	19:cc4f5d01f080	126
Nakor	0:4f009971ac11	127	_oled.putc(0x4C);
Nakor	0:4f009971ac11	128	_oled.putc(x1);
Nakor	0:4f009971ac11	129	_oled.putc(y1);
Nakor	0:4f009971ac11	130	_oled.putc(x2);
Nakor	0:4f009971ac11	131	_oled.putc(y2);
Nakor	0:4f009971ac11	132	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	133	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	134
Nakor	0:4f009971ac11	135	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	136	}
Nakor	0:4f009971ac11	137
Nakor	0:4f009971ac11	138	bool uOLED::drawPolygon(char vertices, char x, char y, short color) {
Nakor	0:4f009971ac11	139	_oled.putc(0x67);
Nakor	0:4f009971ac11	140	_oled.putc(vertices);
Nakor	0:4f009971ac11	141	for (int i=0; i<vertices; i++) {
Nakor	0:4f009971ac11	142	_oled.putc(x[i]);
Nakor	0:4f009971ac11	143	_oled.putc(y[i]);
Nakor	0:4f009971ac11	144	}
Nakor	0:4f009971ac11	145	_oled.putc(color >> 8);
Nakor	0:4f009971ac11	146	_oled.putc(color & 0xFF);
Nakor	0:4f009971ac11	147
Nakor	0:4f009971ac11	148	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	149	}
Nakor	0:4f009971ac11	150
Nakor	21:87a2227c1ad2	151	bool uOLED::drawRectangle(char x, char y, char width, char height, short red, short green, short blue)
Nakor	21:87a2227c1ad2	152	{
Nakor	21:87a2227c1ad2	153	short colour = getRGB(red, green, blue);
Nakor	21:87a2227c1ad2	154
Nakor	0:4f009971ac11	155	_oled.putc(0x72);
Nakor	0:4f009971ac11	156	_oled.putc(x);
Nakor	0:4f009971ac11	157	_oled.putc(y);
Nakor	0:4f009971ac11	158	_oled.putc(x + width);
Nakor	0:4f009971ac11	159	_oled.putc(y + height);
Nakor	21:87a2227c1ad2	160	_oled.putc(colour >> 8);
Nakor	21:87a2227c1ad2	161	_oled.putc(colour & 0xFF);
Nakor	0:4f009971ac11	162
Nakor	0:4f009971ac11	163	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	164	}
Nakor	0:4f009971ac11	165
Nakor	21:87a2227c1ad2	166	bool uOLED::drawText(char column, char row, char font, short red, short green, short blue, char *text)
Nakor	21:87a2227c1ad2	167	{
Nakor	21:87a2227c1ad2	168
Nakor	21:87a2227c1ad2	169	short colour = getRGB(red, green, blue);
Nakor	21:87a2227c1ad2	170
Nakor	0:4f009971ac11	171	_oled.putc(0x73);
Nakor	0:4f009971ac11	172	_oled.putc(column);
Nakor	0:4f009971ac11	173	_oled.putc(row);
Nakor	0:4f009971ac11	174	_oled.putc(font);
Nakor	21:87a2227c1ad2	175	_oled.putc(colour >> 8);
Nakor	21:87a2227c1ad2	176	_oled.putc(colour & 0xFF);
Nakor	0:4f009971ac11	177	for (int i=0 ; i<strlen(text) ; i++) _oled.putc(text[i]);
Nakor	0:4f009971ac11	178	_oled.putc(0x00);
Nakor	0:4f009971ac11	179
Nakor	0:4f009971ac11	180	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	181	}
Nakor	0:4f009971ac11	182
Nakor	14:3d90211095d4	183	bool uOLED::drawTextUF(char x, char y, char font, short red, short green, short blue, char width, char height, char *text) {
Nakor	14:3d90211095d4	184
Nakor	19:cc4f5d01f080	185	short colour = getRGB(red, green, blue);
Nakor	14:3d90211095d4	186
Nakor	14:3d90211095d4	187	_oled.putc(0x53);
Nakor	14:3d90211095d4	188	_oled.putc(x);
Nakor	14:3d90211095d4	189	_oled.putc(y);
Nakor	14:3d90211095d4	190	_oled.putc(font);
Nakor	14:3d90211095d4	191	_oled.putc(colour >> 8);
Nakor	14:3d90211095d4	192	_oled.putc(colour & 0xFF);
Nakor	14:3d90211095d4	193	_oled.putc(width);
Nakor	14:3d90211095d4	194	_oled.putc(height);
Nakor	14:3d90211095d4	195	for (int i=0 ; i<strlen(text) ; i++) _oled.putc(text[i]);
Nakor	14:3d90211095d4	196	_oled.putc(0x00);
Nakor	14:3d90211095d4	197
Nakor	14:3d90211095d4	198	return (_oled.getc() == OLED_ACK);
Nakor	14:3d90211095d4	199	}
Nakor	14:3d90211095d4	200
Nakor	21:87a2227c1ad2	201	bool uOLED::drawTriangle(char x1, char y1, char x2, char y2, char x3, char y3, short red, short green, short blue)
Nakor	21:87a2227c1ad2	202	{
Nakor	21:87a2227c1ad2	203
Nakor	21:87a2227c1ad2	204	short colour = getRGB(red, green, blue);
Nakor	21:87a2227c1ad2	205
Nakor	0:4f009971ac11	206	_oled.putc(0x47);
Nakor	0:4f009971ac11	207	_oled.putc(x1);
Nakor	0:4f009971ac11	208	_oled.putc(y1);
Nakor	0:4f009971ac11	209	_oled.putc(x2);
Nakor	0:4f009971ac11	210	_oled.putc(y2);
Nakor	0:4f009971ac11	211	_oled.putc(x3);
Nakor	0:4f009971ac11	212	_oled.putc(y3);
Nakor	21:87a2227c1ad2	213	_oled.putc(colour >> 8);
Nakor	21:87a2227c1ad2	214	_oled.putc(colour & 0xFF);
Nakor	0:4f009971ac11	215
Nakor	0:4f009971ac11	216	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	217	}
Nakor	0:4f009971ac11	218
Nakor	0:4f009971ac11	219	bool uOLED::eraseScreen() {
Nakor	0:4f009971ac11	220	_oled.putc(0x45);
Nakor	0:4f009971ac11	221
Nakor	0:4f009971ac11	222	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	223	}
Nakor	0:4f009971ac11	224
Nakor	0:4f009971ac11	225	bool uOLED::init() {
Nakor	0:4f009971ac11	226	resetDisplay();
Nakor	0:4f009971ac11	227
Nakor	0:4f009971ac11	228	wait_ms(OLED_INITDELAYMS);
Nakor	0:4f009971ac11	229	_oled.putc(0x55);
Nakor	0:4f009971ac11	230
Nakor	0:4f009971ac11	231	_oled.getc();
Nakor	0:4f009971ac11	232
Nakor	0:4f009971ac11	233	_oled.putc(0x4F);
Nakor	0:4f009971ac11	234	_oled.putc(0x01);
Nakor	0:4f009971ac11	235
Nakor	0:4f009971ac11	236	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	237	}
Nakor	0:4f009971ac11	238
Nakor	0:4f009971ac11	239	bool uOLED::penSize(char size) {
Nakor	0:4f009971ac11	240	_oled.putc(0x70);
Nakor	0:4f009971ac11	241	_oled.putc(size);
Nakor	0:4f009971ac11	242
Nakor	0:4f009971ac11	243	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	244	}
Nakor	0:4f009971ac11	245
Nakor	22:66401b612b1b	246	bool uOLED::putPixel(char x, char y, short red, short green, short blue)
Nakor	22:66401b612b1b	247	{
Nakor	22:66401b612b1b	248	short colour = getRGB(red, green, blue);
Nakor	22:66401b612b1b	249
Nakor	0:4f009971ac11	250	_oled.putc(0x50);
Nakor	0:4f009971ac11	251	_oled.putc(x);
Nakor	0:4f009971ac11	252	_oled.putc(y);
Nakor	0:4f009971ac11	253
Nakor	22:66401b612b1b	254	_oled.putc(colour >> 8);
Nakor	22:66401b612b1b	255	_oled.putc(colour & 0xFF);
Nakor	0:4f009971ac11	256
Nakor	0:4f009971ac11	257	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	258	}
Nakor	0:4f009971ac11	259
Nakor	0:4f009971ac11	260	short uOLED::readPixel(char x, char y) {
Nakor	0:4f009971ac11	261	short returnValue;
Nakor	0:4f009971ac11	262
Nakor	0:4f009971ac11	263	_oled.putc(0x52);
Nakor	0:4f009971ac11	264	_oled.putc(x);
Nakor	0:4f009971ac11	265	_oled.putc(y);
Nakor	0:4f009971ac11	266	returnValue = (_oled.getc() << 8);
Nakor	0:4f009971ac11	267	returnValue += _oled.getc();
Nakor	0:4f009971ac11	268
Nakor	0:4f009971ac11	269	return returnValue;
Nakor	0:4f009971ac11	270	}
Nakor	0:4f009971ac11	271
Nakor	13:f2b9f249bcff	272	bool uOLED::setBackgroundColour(char red, char green, char blue)
Nakor	13:f2b9f249bcff	273	{
Nakor	19:cc4f5d01f080	274	short colour = getRGB(red, green, blue);
Nakor	13:f2b9f249bcff	275
Nakor	13:f2b9f249bcff	276	_oled.putc(0x42);
Nakor	11:1686d4d4bbdb	277
Nakor	13:f2b9f249bcff	278	_oled.putc(colour >> 8);
Nakor	13:f2b9f249bcff	279	_oled.putc(colour & 0xFF);
Nakor	0:4f009971ac11	280
Nakor	0:4f009971ac11	281	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	282	}
Nakor	0:4f009971ac11	283
Nakor	22:66401b612b1b	284	bool uOLED::setFont(char font) {
Nakor	0:4f009971ac11	285	_oled.putc(0x46);
Nakor	22:66401b612b1b	286	_oled.putc(font);
Nakor	0:4f009971ac11	287
Nakor	0:4f009971ac11	288	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	289	}
Nakor	0:4f009971ac11	290
Nakor	22:66401b612b1b	291	bool uOLED::textButton(char state, char x, char y, short red, short green, short blue, char font, short textRed, short textGreen, short textBlue, char textWidth, char textHeight, char *text)
Nakor	22:66401b612b1b	292	{
Nakor	22:66401b612b1b	293	short buttonColour = getRGB(red, green, blue);
Nakor	22:66401b612b1b	294	short textColour = getRGB(textRed, textGreen, textBlue);
Nakor	22:66401b612b1b	295
Nakor	0:4f009971ac11	296	_oled.putc(0x62);
Nakor	0:4f009971ac11	297	_oled.putc(state);
Nakor	0:4f009971ac11	298	_oled.putc(x);
Nakor	0:4f009971ac11	299	_oled.putc(y);
Nakor	22:66401b612b1b	300	_oled.putc(buttonColour >> 8);
Nakor	22:66401b612b1b	301	_oled.putc(buttonColour & 0xFF);
Nakor	0:4f009971ac11	302	_oled.putc(font);
Nakor	22:66401b612b1b	303	_oled.putc(textColour >> 8);
Nakor	22:66401b612b1b	304	_oled.putc(textColour & 0xFF);
Nakor	0:4f009971ac11	305	_oled.putc(textWidth);
Nakor	0:4f009971ac11	306	_oled.putc(textHeight);
Nakor	0:4f009971ac11	307	for (int i=0 ; i<strlen(text) ; i++) _oled.putc(text[i]);
Nakor	0:4f009971ac11	308	_oled.putc(0x00);
Nakor	0:4f009971ac11	309
Nakor	0:4f009971ac11	310	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	311	}
Nakor	0:4f009971ac11	312
Nakor	0:4f009971ac11	313	bool uOLED::textMode(char mode) {
Nakor	0:4f009971ac11	314	_oled.putc(0x4F);
Nakor	0:4f009971ac11	315	_oled.putc(mode);
Nakor	0:4f009971ac11	316
Nakor	0:4f009971ac11	317	return (_oled.getc() == OLED_ACK);
Nakor	0:4f009971ac11	318	}
Nakor	0:4f009971ac11	319
Nakor	0:4f009971ac11	320	bool uOLED::versionInfo(bool onScreen, char *info) {
Nakor	0:4f009971ac11	321	_oled.putc(0x56);
Nakor	0:4f009971ac11	322	if (onScreen) {
Nakor	0:4f009971ac11	323	_oled.putc(0x01);
Nakor	0:4f009971ac11	324	} else {
Nakor	0:4f009971ac11	325	_oled.putc(0x00);
Nakor	0:4f009971ac11	326	}
Nakor	0:4f009971ac11	327
Nakor	0:4f009971ac11	328	info[0] = _oled.getc();
Nakor	0:4f009971ac11	329	info[1] = _oled.getc();
Nakor	0:4f009971ac11	330	info[2] = _oled.getc();
Nakor	0:4f009971ac11	331	info[3] = _oled.getc();
Nakor	0:4f009971ac11	332	info[4] = _oled.getc();
Nakor	0:4f009971ac11	333
Nakor	0:4f009971ac11	334	return true;
Nakor	0:4f009971ac11	335	}

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@22:66401b612b1b, 2010-12-26 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning