Console (VT100 compatible) via Serial interface. More...
#include <device/serialstream.h>
Inheritance diagram for SerialStream: Collaboration diagram for SerialStream:Public Types | |
| enum | Attrib { RESET = 0, BRIGHT = 1, DIM = 2, UNDERSCORE = 4, BLINK = 5, REVERSE = 7, HIDDEN = 8 } |
| Attributes can be used to influence the display of the output. More... | |
| enum | Color { BLACK = 0, RED = 1, GREEN = 2, YELLOW = 3, BLUE = 4, MAGENTA = 5, CYAN = 6, WHITE = 7 } |
| Color codes. More... | |
| Public Types inherited from Serial | |
| COM-Port. More... | |
| Transmission speed. More... | |
| Number of data bits per character. | |
| Number of stop bits per character. | |
| parity bit | |
Public Member Functions | |
| SerialStream (ComPort port=COM1, BaudRate baud_rate=BAUD_115200, DataBits data_bits=DATA_8BIT, StopBits stop_bits=STOP_1BIT, Parity parity=PARITY_NONE) | |
| Constructor for the VT100-compatible console. More... | |
| void | flush () override |
| Method to output the buffer contents of the base class Stringbuffer. More... | |
| void | setForeground (Color c) |
| Change foreground color (for subsequent output) More... | |
| void | setBackground (Color c) |
| Change background color (for subsequent output) More... | |
| void | setAttribute (Attrib a) |
| Change text attribute (for subsequent output) More... | |
| void | reset () |
| Reset terminal. More... | |
| void | setPos (int x, int y) |
| Set the cursor position. More... | |
| bool | getPos (int &x, int &y) |
| Read the current cursor position. More... | |
| void | print (char *str, int length) |
| Display multiple characters in the window starting at the current cursor position. More... | |
| Public Member Functions inherited from OutputStream | |
| Public Member Functions inherited from Stringbuffer | |
| Public Member Functions inherited from Serial | |
Additional Inherited Members | |
| Public Attributes inherited from OutputStream | |
| Protected Member Functions inherited from Stringbuffer | |
| Protected Attributes inherited from Stringbuffer | |
| Protected Attributes inherited from Serial |
Console (VT100 compatible) via Serial interface.
This class allows to connect a VT100-compatible display terminal via the serial interface.
An application to comfortably create a connection (with the ability to configure speed and transfer format) is provided at /proj/i4bs/tools/serial.
For the test systems this has to be executed on the host i4stubs-serial (also known as cip6d0.cip.cs.fau.de).
Example: Connect on i4stubs-serial to the computer 'StuBS4' at 19200 baud with 7 data bits, even parity bit and 2 stop bits:
/proj/i4bs/tools/serial 4 19200 7e2
Color and position can be adjusted with the help of escape codes.
| enum SerialStream::Attrib |
Attributes can be used to influence the display of the output.
| Enumerator | |
|---|---|
| RESET | Turn off character attributes. |
| BRIGHT | Bold. |
| DIM | Low intensity (dimmed) |
| UNDERSCORE | Underline. |
| BLINK | Blink (slow) |
| REVERSE | Swap fore & background. |
| HIDDEN | Concealed. |
| enum SerialStream::Color |
Color codes.
Default VT100 supports eight colors for both foreground and background (later versions 256 [8 bit] and even true color [32 bit]). The actual color is affected by the attributes and can look significantly different depending on the terminal emulator.
|
explicit |
Constructor for the VT100-compatible console.
Sets up the serial connection as well
|
overridevirtual |
Method to output the buffer contents of the base class Stringbuffer.
The method is automatically called when the buffer is full, but can also be called explicitly to force output of the current buffer.
Implements OutputStream.
| void SerialStream::setForeground | ( | Color | c | ) |
Change foreground color (for subsequent output)
| c | Color |
| void SerialStream::setBackground | ( | Color | c | ) |
Change background color (for subsequent output)
| c | Color |
| void SerialStream::setAttribute | ( | Attrib | a | ) |
Change text attribute (for subsequent output)
| a | Attribute |
| void SerialStream::reset | ( | ) |
Reset terminal.
Clear screen, place cursor at the beginning and reset colors and attributes to the default value.
| void SerialStream::setPos | ( | int | x, |
| int | y | ||
| ) |
Set the cursor position.
| x | Column in window |
| y | Row in window |
| bool SerialStream::getPos | ( | int & | x, |
| int & | y | ||
| ) |
Read the current cursor position.
It is possible to receive the current cursor position via a special escape code: Request by sending \e[6n, answer will be \e[y;xR with y (row) and x (column) as human readable ASCII character number.
However, depending on the implementation, it may be possible that the system waits endlessly due to an disconnected terminal or data transmission error.
| x | Column in window |
| y | Row in window |
i4stubs-all@lists.cs.fau.detrue if position was successfully received | void SerialStream::print | ( | char * | str, |
| int | length | ||
| ) |
Display multiple characters in the window starting at the current cursor position.
This method can be used to output a string, starting at the current cursor position. Since the string does not need to contain a '\0' termination (as it is usually the case in C), the parameter length is required to specify the number of characters in the string.
The text is displayed using the previously configured attributes, fore- and background color.
A line break will occur wherever the character \n is inserted in the text to be output (for compatibility reasons a \r is automatically appended).
| str | String to output |
| length | length of string |
