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
Diff: uOLED.h
- Revision:
- 2:559b81f2bb1e
- Parent:
- 1:476dcc382de3
- Child:
- 3:949c5ac54e9c
diff -r 476dcc382de3 -r 559b81f2bb1e uOLED.h --- a/uOLED.h Mon Dec 20 18:19:58 2010 +0000 +++ b/uOLED.h Mon Dec 20 18:26:02 2010 +0000 @@ -40,100 +40,126 @@ /** Dunno * Dunno + * @param serialTX - mbed TX pin to be used + * @param serialRX - mbed RX pin to be used + * @param reset - mbed pin to control reset of the uOLED */ uOLED(PinName serialTX, PinName serialRX, PinName reset); /** Dunno2 * Dunno + * @param returns something. */ short getRGB(char red, char green, char blue); /** Dunno3 * Dunno + * @param returns something. */ bool addBitmappedCharacter(char character, char data[8]); /** Dunno4 * Dunno + * @param returns something. */ bool blockCopyPaste(char sourceX, char sourceY, char destinationX, char destinationY, char width, char height); /** Dunno5 * Dunno + * @param returns something. */ bool displayControl(char mode); /** Dunno6 * Dunno + * @param returns something. */ bool displayUserBitmappedCharacter(char character, char x, char y, short color); /** Dunno7 * Dunno + * @param returns something. */ bool drawCircle(char x, char y, char radius, short color); /** Dunno8 * Dunno + * @param returns something. */ bool drawCharacter(char character, char column, char row, short color); /** Dunno9 * Dunno + * @param returns something. */ bool drawImage(char x, char y, char width, char height, char colorMode, char *pixels); /** Dunno10 * Dunno + * @param returns something. */ bool drawLine(char x1, char y1, char x2, char y2, short color); /** Dunno11 * Dunno + * @param returns something. */ bool drawPolygon(char vertices, char *x, char *y, short color); /** Dunno12 * Dunno + * @param returns something. */ bool drawRectangle(char x, char y, char width, char height, short color); /** Dunno13 * Dunno + * @param returns something. */ bool drawText(char column, char row, char font, short color, char *text); /** Dunno14 * Dunno + * @param returns something. */ bool drawTriangle(char x1, char y1, char x2, char y2, char x3, char y3, short color); /** Dunno15 * Dunno + * @param returns something. */ bool eraseScreen(); /** Initialize the screen. This must be completed before any other communication with the device. * Timing allows for at least 500ms delay for initialization. + * @param returns bool indicating success or failure of initialization. */ bool init(); /** Dunno16 * Dunno + * @param returns something. */ bool penSize(char size); /** Dunno17 * Dunno + * @param returns something. */ bool putPixel(char x, char y, short color); /** Dunno18 * Dunno + * @param returns something. */ short readPixel(char x, char y); /** Dunno19 * Dunno + * @param returns something. */ bool setBackgroundColor(short color); /** Dunno20 * Dunno + * @param returns something. */ bool setFontSize(char fontType); /** Dunno21 * Dunno + * @param returns something. */ bool textButton(char state, char x, char y, short buttonColor, char font, short textColor, char textWidth, char textHeight, char *text); /** Dunno22 * Dunno + * @param returns something. */ bool textMode(char mode); /** Dunno23 * Dunno + * @param returns something. */ bool versionInfo(bool onScreen, char *info);