Alan Ffrench / Mbed 2 deprecated Experiment_2_5

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

C12832_lcd/TextDisplay.h@0:52468b19aa21, 2020-07-29 (annotated)

Committer:
alanffrench
Date:
Wed Jul 29 18:51:38 2020 +0000
Revision:
0:52468b19aa21
Threads

Who changed what in which revision?

UserRevisionLine numberNew contents of line
alanffrench 0:52468b19aa21 1 /* mbed TextDisplay Library Base Class
alanffrench 0:52468b19aa21 2 * Copyright (c) 2007-2009 sford
alanffrench 0:52468b19aa21 3 * Released under the MIT License: http://mbed.org/license/mit
alanffrench 0:52468b19aa21 4 *
alanffrench 0:52468b19aa21 5 * A common base class for Text displays
alanffrench 0:52468b19aa21 6 * To port a new display, derive from this class and implement
alanffrench 0:52468b19aa21 7 * the constructor (setup the display), character (put a character
alanffrench 0:52468b19aa21 8 * at a location), rows and columns (number of rows/cols) functions.
alanffrench 0:52468b19aa21 9 * Everything else (locate, printf, putc, cls) will come for free
alanffrench 0:52468b19aa21 10 *
alanffrench 0:52468b19aa21 11 * The model is the display will wrap at the right and bottom, so you can
alanffrench 0:52468b19aa21 12 * keep writing and will always get valid characters. The location is
alanffrench 0:52468b19aa21 13 * maintained internally to the class to make this easy
alanffrench 0:52468b19aa21 14 */
alanffrench 0:52468b19aa21 15
alanffrench 0:52468b19aa21 16 #ifndef MBED_TEXTDISPLAY_H
alanffrench 0:52468b19aa21 17 #define MBED_TEXTDISPLAY_H
alanffrench 0:52468b19aa21 18
alanffrench 0:52468b19aa21 19 #include "mbed.h"
alanffrench 0:52468b19aa21 20
alanffrench 0:52468b19aa21 21 class TextDisplay : public Stream {
alanffrench 0:52468b19aa21 22 public:
alanffrench 0:52468b19aa21 23
alanffrench 0:52468b19aa21 24 // functions needing implementation in derived implementation class
alanffrench 0:52468b19aa21 25 /** Create a TextDisplay interface
alanffrench 0:52468b19aa21 26 *
alanffrench 0:52468b19aa21 27 * @param name The name used in the path to access the strean through the filesystem
alanffrench 0:52468b19aa21 28 */
alanffrench 0:52468b19aa21 29 TextDisplay(const char *name = NULL);
alanffrench 0:52468b19aa21 30
alanffrench 0:52468b19aa21 31 /** output a character at the given position
alanffrench 0:52468b19aa21 32 *
alanffrench 0:52468b19aa21 33 * @param column column where charater must be written
alanffrench 0:52468b19aa21 34 * @param row where character must be written
alanffrench 0:52468b19aa21 35 * @param c the character to be written to the TextDisplay
alanffrench 0:52468b19aa21 36 */
alanffrench 0:52468b19aa21 37 virtual void character(int column, int row, int c) = 0;
alanffrench 0:52468b19aa21 38
alanffrench 0:52468b19aa21 39 /** return number if rows on TextDisplay
alanffrench 0:52468b19aa21 40 * @result number of rows
alanffrench 0:52468b19aa21 41 */
alanffrench 0:52468b19aa21 42 virtual int rows() = 0;
alanffrench 0:52468b19aa21 43
alanffrench 0:52468b19aa21 44 /** return number if columns on TextDisplay
alanffrench 0:52468b19aa21 45 * @result number of rows
alanffrench 0:52468b19aa21 46 */
alanffrench 0:52468b19aa21 47 virtual int columns() = 0;
alanffrench 0:52468b19aa21 48
alanffrench 0:52468b19aa21 49 // functions that come for free, but can be overwritten
alanffrench 0:52468b19aa21 50
alanffrench 0:52468b19aa21 51 /** redirect output from a stream (stoud, sterr) to display
alanffrench 0:52468b19aa21 52 * @param stream stream that shall be redirected to the TextDisplay
alanffrench 0:52468b19aa21 53 */
alanffrench 0:52468b19aa21 54 virtual bool claim (FILE *stream);
alanffrench 0:52468b19aa21 55
alanffrench 0:52468b19aa21 56 /** clear screen
alanffrench 0:52468b19aa21 57 */
alanffrench 0:52468b19aa21 58 virtual void cls();
alanffrench 0:52468b19aa21 59 virtual void locate(int column, int row);
alanffrench 0:52468b19aa21 60 virtual void foreground(uint16_t colour);
alanffrench 0:52468b19aa21 61 virtual void background(uint16_t colour);
alanffrench 0:52468b19aa21 62 // putc (from Stream)
alanffrench 0:52468b19aa21 63 // printf (from Stream)
alanffrench 0:52468b19aa21 64
alanffrench 0:52468b19aa21 65 protected:
alanffrench 0:52468b19aa21 66
alanffrench 0:52468b19aa21 67 virtual int _putc(int value);
alanffrench 0:52468b19aa21 68 virtual int _getc();
alanffrench 0:52468b19aa21 69
alanffrench 0:52468b19aa21 70 // character location
alanffrench 0:52468b19aa21 71 uint16_t _column;
alanffrench 0:52468b19aa21 72 uint16_t _row;
alanffrench 0:52468b19aa21 73
alanffrench 0:52468b19aa21 74 // colours
alanffrench 0:52468b19aa21 75 uint16_t _foreground;
alanffrench 0:52468b19aa21 76 uint16_t _background;
alanffrench 0:52468b19aa21 77 char *_path;
alanffrench 0:52468b19aa21 78 };
alanffrench 0:52468b19aa21 79
alanffrench 0:52468b19aa21 80 #endif