Campbell Scientific Australia / Mbed 2 deprecated mDot_Semtech_LoRaWAN_Stack

This code uses Semtech's open source LoRaWAN stack ported to mbed environment.

Dependencies:   mbed LoRaWAN-lib SX1272Lib

app/vt100.h@1:7da3f0db0d82, 2016-06-10 (annotated)

Committer:
Mehrad
Date:
Fri Jun 10 00:01:00 2016 +0000
Revision:
1:7da3f0db0d82
Parent:
0:6155544d38b1 
Initial commit

Who changed what in which revision?

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