FlexBook / Mbed 2 deprecated FlexBook171204a

Added HangmanGame class, but does not work yet

Dependencies:   SDFileSystem app epson mbed msp430 pl tests

eink.h@0:fa7450a43b99, 2017-12-04 (annotated)

Committer:
group-FlexBook
Date:
Mon Dec 04 09:32:20 2017 +0000
Revision:
0:fa7450a43b99
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-FlexBook 0:fa7450a43b99 1 //
group-FlexBook 0:fa7450a43b99 2 // Filename: eink.h
group-FlexBook 0:fa7450a43b99 3 //
group-FlexBook 0:fa7450a43b99 4 // Flexbook eInk display driver definitions.
group-FlexBook 0:fa7450a43b99 5 //
group-FlexBook 0:fa7450a43b99 6
group-FlexBook 0:fa7450a43b99 7 #ifndef EINK_H
group-FlexBook 0:fa7450a43b99 8 #define EINK_H
group-FlexBook 0:fa7450a43b99 9
group-FlexBook 0:fa7450a43b99 10 #include "mbed.h"
group-FlexBook 0:fa7450a43b99 11
group-FlexBook 0:fa7450a43b99 12 /**
group-FlexBook 0:fa7450a43b99 13 * @brief Initialise the display hardware.
group-FlexBook 0:fa7450a43b99 14 * @param i2c The I2C to use for control data.
group-FlexBook 0:fa7450a43b99 15 * @param spi The SPI to use for data.
group-FlexBook 0:fa7450a43b99 16 * @param spics The SPI chip select line (the Epson driver manually sets it).
group-FlexBook 0:fa7450a43b99 17 * @param hven The display enable line.
group-FlexBook 0:fa7450a43b99 18 * @param rst The Epson controller rest line.
group-FlexBook 0:fa7450a43b99 19 * @param hvpok The power OK signal.
group-FlexBook 0:fa7450a43b99 20 */
group-FlexBook 0:fa7450a43b99 21 void InitDisplay(I2C &i2c, SPI &spi, DigitalOut &spics, DigitalOut &hven, DigitalOut &rst, DigitalIn &hvpok);
group-FlexBook 0:fa7450a43b99 22 void WriteImage(const int numimage);
group-FlexBook 0:fa7450a43b99 23
group-FlexBook 0:fa7450a43b99 24 struct pl_epdc;
group-FlexBook 0:fa7450a43b99 25
group-FlexBook 0:fa7450a43b99 26 /**
group-FlexBook 0:fa7450a43b99 27 * @brief Write a colour to the entire screen.
group-FlexBook 0:fa7450a43b99 28 * @param epdc The eInk device.
group-FlexBook 0:fa7450a43b99 29 * @param colour The colour to write.
group-FlexBook 0:fa7450a43b99 30 */
group-FlexBook 0:fa7450a43b99 31 void WriteColour(pl_epdc &epdc, uint8_t colour);
group-FlexBook 0:fa7450a43b99 32
group-FlexBook 0:fa7450a43b99 33 /**
group-FlexBook 0:fa7450a43b99 34 * @brief Write an image to the screen.
group-FlexBook 0:fa7450a43b99 35 * @param file The file to write e.g. "/myfile.pgm".
group-FlexBook 0:fa7450a43b99 36 */
group-FlexBook 0:fa7450a43b99 37 void WriteImage(const char *file);
group-FlexBook 0:fa7450a43b99 38
group-FlexBook 0:fa7450a43b99 39 /**
group-FlexBook 0:fa7450a43b99 40 * @brief Write a partial image to the display.
group-FlexBook 0:fa7450a43b99 41 * @param file The file to write e.g. "/myfile.pgm".
group-FlexBook 0:fa7450a43b99 42 * @param xd X display coordinate.
group-FlexBook 0:fa7450a43b99 43 * @param yd Y display coordinate.
group-FlexBook 0:fa7450a43b99 44 * @param xi X image coordinate.
group-FlexBook 0:fa7450a43b99 45 * @param yi Y image coordinate.
group-FlexBook 0:fa7450a43b99 46 * @param w Width of image.
group-FlexBook 0:fa7450a43b99 47 * @param h Height of image.
group-FlexBook 0:fa7450a43b99 48 */
group-FlexBook 0:fa7450a43b99 49 void WritePartImage(const char *filename, int xd, int yd, int xi, int yi, int w, int h);
group-FlexBook 0:fa7450a43b99 50
group-FlexBook 0:fa7450a43b99 51 /**
group-FlexBook 0:fa7450a43b99 52 * @brief Update the eInk display.
group-FlexBook 0:fa7450a43b99 53 */
group-FlexBook 0:fa7450a43b99 54 void UpdateDisplay();
group-FlexBook 0:fa7450a43b99 55
group-FlexBook 0:fa7450a43b99 56 /**
group-FlexBook 0:fa7450a43b99 57 * @brief Display hardware settings. Use the VERBOSE preprocessor define to see more information.
group-FlexBook 0:fa7450a43b99 58 */
group-FlexBook 0:fa7450a43b99 59 void DisplayHardwareSettings();
group-FlexBook 0:fa7450a43b99 60
group-FlexBook 0:fa7450a43b99 61 /**
group-FlexBook 0:fa7450a43b99 62 * @ brief Get a handle to the display device information.
group-FlexBook 0:fa7450a43b99 63 * This information is only valid after InitDiaplay() has been called.
group-FlexBook 0:fa7450a43b99 64 * Use this to pass to WritePicture and WriteColour.
group-FlexBook 0:fa7450a43b99 65 * @return The eInk device information struct.
group-FlexBook 0:fa7450a43b99 66 */
group-FlexBook 0:fa7450a43b99 67 pl_epdc &Get_epdc();
group-FlexBook 0:fa7450a43b99 68
group-FlexBook 0:fa7450a43b99 69 #endif // EINK_H
group-FlexBook 0:fa7450a43b99 70