Toby Harris / spk_oled_ssd1305

SPKDisplay - A mbed display class and processing imaging tools for 128x64 OLEDs using the SSD1305 driver, connected via SPI.

Dependents:   SPK-DVIMXR SPK-DMXer

spk_oled_ssd1305.h@1:dd3faa2ab1dd, 2012-04-15 (annotated)

Committer:
tobyspark
Date:
Sun Apr 15 19:39:17 2012 +0000
Revision:
1:dd3faa2ab1dd
Parent:
0:76bb084fa033
Child:
2:8187d69071f8
Image and font are fully external to class, ie. it will compile for others!

Who changed what in which revision?

UserRevisionLine numberNew contents of line
tobyspark 0:76bb084fa033 1 // OLED display using SSD1305 driver
tobyspark 0:76bb084fa033 2 // Copyright *spark audio-visual 2012
tobyspark 1:dd3faa2ab1dd 3 //
tobyspark 1:dd3faa2ab1dd 4 // This library is free software; you can redistribute it and/or
tobyspark 1:dd3faa2ab1dd 5 // modify it under the terms of the GNU Lesser General Public
tobyspark 1:dd3faa2ab1dd 6 // License version 3 as published by the Free Software Foundation.
tobyspark 0:76bb084fa033 7
tobyspark 0:76bb084fa033 8 #ifndef SPK_OLED_SSD1305_h
tobyspark 0:76bb084fa033 9 #define SPK_OLED_SSD1305_h
tobyspark 0:76bb084fa033 10
tobyspark 0:76bb084fa033 11 #include "mbed.h"
tobyspark 0:76bb084fa033 12 #include <string>
tobyspark 0:76bb084fa033 13
tobyspark 0:76bb084fa033 14 #define bufferCount 1056
tobyspark 0:76bb084fa033 15 #define bufferWidth 132
tobyspark 0:76bb084fa033 16 #define pixelWidth 128
tobyspark 0:76bb084fa033 17 #define pixelHeight 64
tobyspark 0:76bb084fa033 18 #define pixInPage 8
tobyspark 0:76bb084fa033 19 #define pageCount 8
tobyspark 0:76bb084fa033 20
tobyspark 0:76bb084fa033 21 /** Display class for 128x64 OLEDs using the SSD1305 driver
tobyspark 1:dd3faa2ab1dd 22 * Display ie. DENSITRON - DD-12864YO-3A
tobyspark 0:76bb084fa033 23 *
tobyspark 1:dd3faa2ab1dd 24 * This is a ground-up, minimal library. Further functionality as and when its needed or anybody wants to contribute.
tobyspark 0:76bb084fa033 25 *
tobyspark 0:76bb084fa033 26 * This library includes two processing sketches to create a font and full-screen image in the required byte representations.
tobyspark 1:dd3faa2ab1dd 27 * Without creating your a font and image, all this library will do is blank the screen and draw horizontal lines. But at least you'll know its working!
tobyspark 0:76bb084fa033 28 *
tobyspark 0:76bb084fa033 29 * Terminology:
tobyspark 0:76bb084fa033 30 * 'rows' are 8 pixel high rows across the display, 0 being the topmost and 7 the bottom.
tobyspark 0:76bb084fa033 31 * 'lines' are single pixel lines, origin top left
tobyspark 0:76bb084fa033 32 *
tobyspark 0:76bb084fa033 33 * Example:
tobyspark 0:76bb084fa033 34 * @code
tobyspark 1:dd3faa2ab1dd 35 * // Create object and load font
tobyspark 0:76bb084fa033 36 * SPKDisplay screen(p5, p7, p8, p10, p9)
tobyspark 1:dd3faa2ab1dd 37 * screen.fontStartCharacter = &myStartChar;
tobyspark 1:dd3faa2ab1dd 38 * screen.fontEndCharacter = &myEndChar;
tobyspark 1:dd3faa2ab1dd 39 * screen.fontCharacters = myFontArray;
tobyspark 1:dd3faa2ab1dd 40 * // Draw
tobyspark 1:dd3faa2ab1dd 41 * screen.imageToBuffer(myImageByteArray);
tobyspark 0:76bb084fa033 42 * screen.textToBuffer("*spark OLED SSD1305",0);
tobyspark 0:76bb084fa033 43 * screen.textToBuffer("v01",1);
tobyspark 0:76bb084fa033 44 * screen.sendBuffer
tobyspark 0:76bb084fa033 45 * @endcode
tobyspark 0:76bb084fa033 46 */
tobyspark 0:76bb084fa033 47 class SPKDisplay
tobyspark 0:76bb084fa033 48 {
tobyspark 0:76bb084fa033 49 public:
tobyspark 0:76bb084fa033 50 /** Create a display object connected via SPI
tobyspark 0:76bb084fa033 51 *
tobyspark 0:76bb084fa033 52 * @param mosi SPI MOSI
tobyspark 0:76bb084fa033 53 * @param clk SPI SCK
tobyspark 0:76bb084fa033 54 * @param cs Chip Select - a digital out pin
tobyspark 0:76bb084fa033 55 * @param dc Data/Command - a digital out pin
tobyspark 0:76bb084fa033 56 * @param res Reset - a digital out pin
tobyspark 0:76bb084fa033 57 * @param debugSerial An optional serial object to log to
tobyspark 0:76bb084fa033 58 */
tobyspark 0:76bb084fa033 59 SPKDisplay(PinName mosi, PinName clk, PinName cs, PinName dc, PinName res, Serial *debugSerial = NULL);
tobyspark 0:76bb084fa033 60
tobyspark 1:dd3faa2ab1dd 61 /** Font - Assign the ASCII value of the character at the start of the implemented range */
tobyspark 1:dd3faa2ab1dd 62 const int *fontStartCharacter;
tobyspark 1:dd3faa2ab1dd 63
tobyspark 1:dd3faa2ab1dd 64 /** Font - Assign the ASCII value of the character at the end of the implemented range */
tobyspark 1:dd3faa2ab1dd 65 const int *fontEndCharacter;
tobyspark 1:dd3faa2ab1dd 66
tobyspark 1:dd3faa2ab1dd 67 /** Font - Assign the font, an array of 8x8px characters
tobyspark 1:dd3faa2ab1dd 68 *
tobyspark 1:dd3faa2ab1dd 69 * @note The processing sketch spk_oled_fontByteMaker--processing takes characterCount*8px x 8px images and creates the code to declare the font array needed by this method
tobyspark 1:dd3faa2ab1dd 70 */
tobyspark 1:dd3faa2ab1dd 71 uint8_t const **fontCharacters;
tobyspark 1:dd3faa2ab1dd 72
tobyspark 0:76bb084fa033 73 /** Completely clear the object's display representation */
tobyspark 0:76bb084fa033 74 void clearBuffer();
tobyspark 0:76bb084fa033 75
tobyspark 0:76bb084fa033 76 /** Clear a row of the object's display representation
tobyspark 0:76bb084fa033 77 *
tobyspark 0:76bb084fa033 78 * @param row The row to clear.
tobyspark 0:76bb084fa033 79 */
tobyspark 0:76bb084fa033 80 void clearBufferRow(int row);
tobyspark 0:76bb084fa033 81
tobyspark 1:dd3faa2ab1dd 82 /** Replace the object\s display representation with the contents of image
tobyspark 1:dd3faa2ab1dd 83 *
tobyspark 1:dd3faa2ab1dd 84 * @param image An array of 1056 bytes representing an image.
tobyspark 1:dd3faa2ab1dd 85 * @note The processing sketch spk_oled_screenByteMaker--processing takes 132x64 images and creates the code to declare such arrays
tobyspark 1:dd3faa2ab1dd 86 */
tobyspark 1:dd3faa2ab1dd 87 void imageToBuffer(const uint8_t* image);
tobyspark 0:76bb084fa033 88
tobyspark 0:76bb084fa033 89 /** Draw a horizontal line in the object's display representation
tobyspark 0:76bb084fa033 90 *
tobyspark 0:76bb084fa033 91 * @param y The y position of the line to draw
tobyspark 0:76bb084fa033 92 */
tobyspark 0:76bb084fa033 93 void horizLineToBuffer(int y);
tobyspark 0:76bb084fa033 94
tobyspark 0:76bb084fa033 95 /** Write a line of text in the object's display representation
tobyspark 1:dd3faa2ab1dd 96 * Requires the font to have been set
tobyspark 0:76bb084fa033 97 *
tobyspark 0:76bb084fa033 98 * @param message The text to write. The text will be truncated if longer than the screen's width.
tobyspark 0:76bb084fa033 99 * @param row The row in which to write the text
tobyspark 0:76bb084fa033 100 */
tobyspark 0:76bb084fa033 101 void textToBuffer(std::string message, int row);
tobyspark 0:76bb084fa033 102
tobyspark 0:76bb084fa033 103 /** Send the object's display representation to the OLED
tobyspark 0:76bb084fa033 104 *
tobyspark 0:76bb084fa033 105 * You can safely call this once per main loop, it will only transmit the buffer contents if there has been an update
tobyspark 0:76bb084fa033 106 */
tobyspark 0:76bb084fa033 107 void sendBuffer();
tobyspark 0:76bb084fa033 108
tobyspark 0:76bb084fa033 109 private:
tobyspark 0:76bb084fa033 110 SPI *spi;
tobyspark 0:76bb084fa033 111 DigitalOut *cs;
tobyspark 0:76bb084fa033 112 DigitalOut *dc;
tobyspark 0:76bb084fa033 113 DigitalOut *res;
tobyspark 0:76bb084fa033 114
tobyspark 0:76bb084fa033 115 Serial *debug;
tobyspark 0:76bb084fa033 116 uint8_t buffer[bufferCount];
tobyspark 0:76bb084fa033 117
tobyspark 0:76bb084fa033 118 bool bufferHasChanged;
tobyspark 0:76bb084fa033 119
tobyspark 0:76bb084fa033 120 void setup();
tobyspark 0:76bb084fa033 121 };
tobyspark 0:76bb084fa033 122
tobyspark 0:76bb084fa033 123 #endif