LR Initial Publish
Dependencies: X_NUCLEO_IKS01A2 driver_mbed_TH02 mbed LoRaWAN-lib-v1_0_1 SX1272Lib
Fork of Training-Aug2018-SX1272-X-NUCLEO-IKS01A2 by
app/vt100.h@0:6cc76d70e2a1, 2017-04-06 (annotated)
- Committer:
- ubhat
- Date:
- Thu Apr 06 21:59:50 2017 +0000
- Revision:
- 0:6cc76d70e2a1
LoRaWAN SX1272 Application
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
ubhat | 0:6cc76d70e2a1 | 1 | /* |
ubhat | 0:6cc76d70e2a1 | 2 | / _____) _ | | |
ubhat | 0:6cc76d70e2a1 | 3 | ( (____ _____ ____ _| |_ _____ ____| |__ |
ubhat | 0:6cc76d70e2a1 | 4 | \____ \| ___ | (_ _) ___ |/ ___) _ \ |
ubhat | 0:6cc76d70e2a1 | 5 | _____) ) ____| | | || |_| ____( (___| | | | |
ubhat | 0:6cc76d70e2a1 | 6 | (______/|_____)_|_|_| \__)_____)\____)_| |_| |
ubhat | 0:6cc76d70e2a1 | 7 | (C)2015 Semtech |
ubhat | 0:6cc76d70e2a1 | 8 | |
ubhat | 0:6cc76d70e2a1 | 9 | Description: VT100 terminal support class |
ubhat | 0:6cc76d70e2a1 | 10 | |
ubhat | 0:6cc76d70e2a1 | 11 | License: Revised BSD License, see LICENSE.TXT file include in the project |
ubhat | 0:6cc76d70e2a1 | 12 | |
ubhat | 0:6cc76d70e2a1 | 13 | Maintainer: Miguel Luis and Gregory Cristian |
ubhat | 0:6cc76d70e2a1 | 14 | */ |
ubhat | 0:6cc76d70e2a1 | 15 | #ifndef __VT100_H__ |
ubhat | 0:6cc76d70e2a1 | 16 | #define __VT100_H__ |
ubhat | 0:6cc76d70e2a1 | 17 | |
ubhat | 0:6cc76d70e2a1 | 18 | #ifndef STRING_STACK_LIMIT |
ubhat | 0:6cc76d70e2a1 | 19 | #define STRING_STACK_LIMIT 120 |
ubhat | 0:6cc76d70e2a1 | 20 | #endif |
ubhat | 0:6cc76d70e2a1 | 21 | |
ubhat | 0:6cc76d70e2a1 | 22 | /** |
ubhat | 0:6cc76d70e2a1 | 23 | * Implements VT100 terminal commands support. |
ubhat | 0:6cc76d70e2a1 | 24 | * Implments also the same behaviour has RawSerial class. The only difference |
ubhat | 0:6cc76d70e2a1 | 25 | * is located in putc fucntion where writeable check is made befor sending the character. |
ubhat | 0:6cc76d70e2a1 | 26 | */ |
ubhat | 0:6cc76d70e2a1 | 27 | class VT100 : public SerialBase |
ubhat | 0:6cc76d70e2a1 | 28 | { |
ubhat | 0:6cc76d70e2a1 | 29 | public: |
ubhat | 0:6cc76d70e2a1 | 30 | enum TextAttributes |
ubhat | 0:6cc76d70e2a1 | 31 | { |
ubhat | 0:6cc76d70e2a1 | 32 | ATTR_OFF = 0, |
ubhat | 0:6cc76d70e2a1 | 33 | BOLD = 1, |
ubhat | 0:6cc76d70e2a1 | 34 | USCORE = 4, |
ubhat | 0:6cc76d70e2a1 | 35 | BLINK = 5, |
ubhat | 0:6cc76d70e2a1 | 36 | REVERSE = 7, |
ubhat | 0:6cc76d70e2a1 | 37 | BOLD_OFF = 21, |
ubhat | 0:6cc76d70e2a1 | 38 | USCORE_OFF = 24, |
ubhat | 0:6cc76d70e2a1 | 39 | BLINK_OFF = 25, |
ubhat | 0:6cc76d70e2a1 | 40 | REVERSE_OFF = 27, |
ubhat | 0:6cc76d70e2a1 | 41 | }; |
ubhat | 0:6cc76d70e2a1 | 42 | |
ubhat | 0:6cc76d70e2a1 | 43 | enum Colors |
ubhat | 0:6cc76d70e2a1 | 44 | { |
ubhat | 0:6cc76d70e2a1 | 45 | BLACK = 0, |
ubhat | 0:6cc76d70e2a1 | 46 | RED = 1, |
ubhat | 0:6cc76d70e2a1 | 47 | GREEN = 2, |
ubhat | 0:6cc76d70e2a1 | 48 | BROWN = 3, |
ubhat | 0:6cc76d70e2a1 | 49 | BLUE = 4, |
ubhat | 0:6cc76d70e2a1 | 50 | MAGENTA = 5, |
ubhat | 0:6cc76d70e2a1 | 51 | CYAN = 6, |
ubhat | 0:6cc76d70e2a1 | 52 | WHITE = 7, |
ubhat | 0:6cc76d70e2a1 | 53 | }; |
ubhat | 0:6cc76d70e2a1 | 54 | |
ubhat | 0:6cc76d70e2a1 | 55 | VT100( PinName tx, PinName rx ): SerialBase( tx, rx ) |
ubhat | 0:6cc76d70e2a1 | 56 | { |
ubhat | 0:6cc76d70e2a1 | 57 | this->baud( 115200 ); |
ubhat | 0:6cc76d70e2a1 | 58 | // initializes terminal to "power-on" settings |
ubhat | 0:6cc76d70e2a1 | 59 | // ESC c |
ubhat | 0:6cc76d70e2a1 | 60 | this->printf( "\x1B\x63" ); |
ubhat | 0:6cc76d70e2a1 | 61 | } |
ubhat | 0:6cc76d70e2a1 | 62 | |
ubhat | 0:6cc76d70e2a1 | 63 | void ClearScreen( uint8_t param ) |
ubhat | 0:6cc76d70e2a1 | 64 | { |
ubhat | 0:6cc76d70e2a1 | 65 | // ESC [ Ps J |
ubhat | 0:6cc76d70e2a1 | 66 | // 0 Clear screen from cursor down |
ubhat | 0:6cc76d70e2a1 | 67 | // 1 Clear screen from cursor up |
ubhat | 0:6cc76d70e2a1 | 68 | // 2 Clear entire screen |
ubhat | 0:6cc76d70e2a1 | 69 | this->printf( "\x1B[%dJ", param ); |
ubhat | 0:6cc76d70e2a1 | 70 | } |
ubhat | 0:6cc76d70e2a1 | 71 | |
ubhat | 0:6cc76d70e2a1 | 72 | void ClearLine( uint8_t param ) |
ubhat | 0:6cc76d70e2a1 | 73 | { |
ubhat | 0:6cc76d70e2a1 | 74 | // ESC [ Ps K |
ubhat | 0:6cc76d70e2a1 | 75 | // 0 Erase from the active position to the end of the line, inclusive (default) |
ubhat | 0:6cc76d70e2a1 | 76 | // 1 Erase from the start of the screen to the active position, inclusive |
ubhat | 0:6cc76d70e2a1 | 77 | // 2 Erase all of the line, inclusive |
ubhat | 0:6cc76d70e2a1 | 78 | this->printf( "\x1B[%dK", param ); |
ubhat | 0:6cc76d70e2a1 | 79 | } |
ubhat | 0:6cc76d70e2a1 | 80 | |
ubhat | 0:6cc76d70e2a1 | 81 | void SetAttribute( uint8_t attr ) |
ubhat | 0:6cc76d70e2a1 | 82 | { |
ubhat | 0:6cc76d70e2a1 | 83 | // ESC [ Ps;...;Ps m |
ubhat | 0:6cc76d70e2a1 | 84 | this->printf( "\x1B[%dm", attr ); |
ubhat | 0:6cc76d70e2a1 | 85 | } |
ubhat | 0:6cc76d70e2a1 | 86 | |
ubhat | 0:6cc76d70e2a1 | 87 | void SetAttribute( uint8_t attr, uint8_t fgcolor, uint8_t bgcolor ) |
ubhat | 0:6cc76d70e2a1 | 88 | { |
ubhat | 0:6cc76d70e2a1 | 89 | // ESC [ Ps;...;Ps m |
ubhat | 0:6cc76d70e2a1 | 90 | this->printf( "\x1B[%d;%d;%dm", attr, fgcolor + 30, bgcolor + 40 ); |
ubhat | 0:6cc76d70e2a1 | 91 | } |
ubhat | 0:6cc76d70e2a1 | 92 | |
ubhat | 0:6cc76d70e2a1 | 93 | void SetCursorMode( uint8_t visible ) |
ubhat | 0:6cc76d70e2a1 | 94 | { |
ubhat | 0:6cc76d70e2a1 | 95 | if( visible == true ) |
ubhat | 0:6cc76d70e2a1 | 96 | { |
ubhat | 0:6cc76d70e2a1 | 97 | // ESC [ ? 25 h |
ubhat | 0:6cc76d70e2a1 | 98 | this->printf( "\x1B[?25h" ); |
ubhat | 0:6cc76d70e2a1 | 99 | } |
ubhat | 0:6cc76d70e2a1 | 100 | else |
ubhat | 0:6cc76d70e2a1 | 101 | { |
ubhat | 0:6cc76d70e2a1 | 102 | // ESC [ ? 25 l |
ubhat | 0:6cc76d70e2a1 | 103 | this->printf( "\x1B[?25l" ); |
ubhat | 0:6cc76d70e2a1 | 104 | } |
ubhat | 0:6cc76d70e2a1 | 105 | } |
ubhat | 0:6cc76d70e2a1 | 106 | |
ubhat | 0:6cc76d70e2a1 | 107 | void SetCursorPos( uint8_t line, uint8_t col ) |
ubhat | 0:6cc76d70e2a1 | 108 | { |
ubhat | 0:6cc76d70e2a1 | 109 | // ESC [ Pl ; Pc H |
ubhat | 0:6cc76d70e2a1 | 110 | this->printf( "\x1B[%d;%dH", line, col ); |
ubhat | 0:6cc76d70e2a1 | 111 | } |
ubhat | 0:6cc76d70e2a1 | 112 | |
ubhat | 0:6cc76d70e2a1 | 113 | void PutStringAt( uint8_t line, uint8_t col, const char *s ) |
ubhat | 0:6cc76d70e2a1 | 114 | { |
ubhat | 0:6cc76d70e2a1 | 115 | this->SetCursorPos( line, col ); |
ubhat | 0:6cc76d70e2a1 | 116 | this->printf( "%s", s ); |
ubhat | 0:6cc76d70e2a1 | 117 | } |
ubhat | 0:6cc76d70e2a1 | 118 | |
ubhat | 0:6cc76d70e2a1 | 119 | void PutCharAt( uint8_t line, uint8_t col, uint8_t c ) |
ubhat | 0:6cc76d70e2a1 | 120 | { |
ubhat | 0:6cc76d70e2a1 | 121 | this->SetCursorPos( line, col ); |
ubhat | 0:6cc76d70e2a1 | 122 | this->printf( "%c", c ); |
ubhat | 0:6cc76d70e2a1 | 123 | } |
ubhat | 0:6cc76d70e2a1 | 124 | |
ubhat | 0:6cc76d70e2a1 | 125 | void PutHexAt( uint8_t line, uint8_t col, uint16_t n ) |
ubhat | 0:6cc76d70e2a1 | 126 | { |
ubhat | 0:6cc76d70e2a1 | 127 | this->SetCursorPos( line, col ); |
ubhat | 0:6cc76d70e2a1 | 128 | this->printf( "%X", n ); |
ubhat | 0:6cc76d70e2a1 | 129 | } |
ubhat | 0:6cc76d70e2a1 | 130 | |
ubhat | 0:6cc76d70e2a1 | 131 | void PutBoxDrawingChar( uint8_t c ) |
ubhat | 0:6cc76d70e2a1 | 132 | { |
ubhat | 0:6cc76d70e2a1 | 133 | this->printf( "\x1B(0%c\x1b(B", c ); |
ubhat | 0:6cc76d70e2a1 | 134 | } |
ubhat | 0:6cc76d70e2a1 | 135 | |
ubhat | 0:6cc76d70e2a1 | 136 | bool Readable( void ) |
ubhat | 0:6cc76d70e2a1 | 137 | { |
ubhat | 0:6cc76d70e2a1 | 138 | return this->readable( ); |
ubhat | 0:6cc76d70e2a1 | 139 | } |
ubhat | 0:6cc76d70e2a1 | 140 | |
ubhat | 0:6cc76d70e2a1 | 141 | uint8_t GetChar( void ) |
ubhat | 0:6cc76d70e2a1 | 142 | { |
ubhat | 0:6cc76d70e2a1 | 143 | return this->getc( ); |
ubhat | 0:6cc76d70e2a1 | 144 | } |
ubhat | 0:6cc76d70e2a1 | 145 | |
ubhat | 0:6cc76d70e2a1 | 146 | /* |
ubhat | 0:6cc76d70e2a1 | 147 | * RawSerial class implmentation copy. |
ubhat | 0:6cc76d70e2a1 | 148 | */ |
ubhat | 0:6cc76d70e2a1 | 149 | /** Read a char from the serial port |
ubhat | 0:6cc76d70e2a1 | 150 | * |
ubhat | 0:6cc76d70e2a1 | 151 | * @returns The char read from the serial port |
ubhat | 0:6cc76d70e2a1 | 152 | */ |
ubhat | 0:6cc76d70e2a1 | 153 | int getc( ) |
ubhat | 0:6cc76d70e2a1 | 154 | { |
ubhat | 0:6cc76d70e2a1 | 155 | return _base_getc(); |
ubhat | 0:6cc76d70e2a1 | 156 | } |
ubhat | 0:6cc76d70e2a1 | 157 | |
ubhat | 0:6cc76d70e2a1 | 158 | /** Write a char to the serial port |
ubhat | 0:6cc76d70e2a1 | 159 | * |
ubhat | 0:6cc76d70e2a1 | 160 | * @param c The char to write |
ubhat | 0:6cc76d70e2a1 | 161 | * |
ubhat | 0:6cc76d70e2a1 | 162 | * @returns The written char or -1 if an error occured |
ubhat | 0:6cc76d70e2a1 | 163 | */ |
ubhat | 0:6cc76d70e2a1 | 164 | int putc( int c ) |
ubhat | 0:6cc76d70e2a1 | 165 | { |
ubhat | 0:6cc76d70e2a1 | 166 | while( this->writeable( ) != 1 ); |
ubhat | 0:6cc76d70e2a1 | 167 | return _base_putc( c ); |
ubhat | 0:6cc76d70e2a1 | 168 | } |
ubhat | 0:6cc76d70e2a1 | 169 | |
ubhat | 0:6cc76d70e2a1 | 170 | /** Write a string to the serial port |
ubhat | 0:6cc76d70e2a1 | 171 | * |
ubhat | 0:6cc76d70e2a1 | 172 | * @param str The string to write |
ubhat | 0:6cc76d70e2a1 | 173 | * |
ubhat | 0:6cc76d70e2a1 | 174 | * @returns 0 if the write succeeds, EOF for error |
ubhat | 0:6cc76d70e2a1 | 175 | */ |
ubhat | 0:6cc76d70e2a1 | 176 | int puts( const char *str ) |
ubhat | 0:6cc76d70e2a1 | 177 | { |
ubhat | 0:6cc76d70e2a1 | 178 | while( *str ) |
ubhat | 0:6cc76d70e2a1 | 179 | putc( *str++ ); |
ubhat | 0:6cc76d70e2a1 | 180 | return 0; |
ubhat | 0:6cc76d70e2a1 | 181 | } |
ubhat | 0:6cc76d70e2a1 | 182 | |
ubhat | 0:6cc76d70e2a1 | 183 | // Experimental support for printf in RawSerial. No Stream inheritance |
ubhat | 0:6cc76d70e2a1 | 184 | // means we can't call printf() directly, so we use sprintf() instead. |
ubhat | 0:6cc76d70e2a1 | 185 | // We only call malloc() for the sprintf() buffer if the buffer |
ubhat | 0:6cc76d70e2a1 | 186 | // length is above a certain threshold, otherwise we use just the stack. |
ubhat | 0:6cc76d70e2a1 | 187 | int printf( const char *format, ... ) |
ubhat | 0:6cc76d70e2a1 | 188 | { |
ubhat | 0:6cc76d70e2a1 | 189 | std::va_list arg; |
ubhat | 0:6cc76d70e2a1 | 190 | va_start( arg, format ); |
ubhat | 0:6cc76d70e2a1 | 191 | int len = vsnprintf( NULL, 0, format, arg ); |
ubhat | 0:6cc76d70e2a1 | 192 | if( len < STRING_STACK_LIMIT ) |
ubhat | 0:6cc76d70e2a1 | 193 | { |
ubhat | 0:6cc76d70e2a1 | 194 | char temp[STRING_STACK_LIMIT]; |
ubhat | 0:6cc76d70e2a1 | 195 | vsprintf( temp, format, arg ); |
ubhat | 0:6cc76d70e2a1 | 196 | puts( temp ); |
ubhat | 0:6cc76d70e2a1 | 197 | } |
ubhat | 0:6cc76d70e2a1 | 198 | else |
ubhat | 0:6cc76d70e2a1 | 199 | { |
ubhat | 0:6cc76d70e2a1 | 200 | char *temp = new char[len + 1]; |
ubhat | 0:6cc76d70e2a1 | 201 | vsprintf( temp, format, arg ); |
ubhat | 0:6cc76d70e2a1 | 202 | puts( temp ); |
ubhat | 0:6cc76d70e2a1 | 203 | delete[] temp; |
ubhat | 0:6cc76d70e2a1 | 204 | } |
ubhat | 0:6cc76d70e2a1 | 205 | va_end( arg ); |
ubhat | 0:6cc76d70e2a1 | 206 | return len; |
ubhat | 0:6cc76d70e2a1 | 207 | } |
ubhat | 0:6cc76d70e2a1 | 208 | |
ubhat | 0:6cc76d70e2a1 | 209 | private: |
ubhat | 0:6cc76d70e2a1 | 210 | |
ubhat | 0:6cc76d70e2a1 | 211 | }; |
ubhat | 0:6cc76d70e2a1 | 212 | |
ubhat | 0:6cc76d70e2a1 | 213 | #endif // __VT100_H__ |