added fxs to class
Dependents: ard2pmod_demo MAXREFDES130_Demo OneWire_DS18B20_Demo MAXREFDES132_OneWire_Demo
Fork of Terminal by
Terminal.h@5:5d3dc5f8f7b4, 2016-06-03 (annotated)
- Committer:
- j3
- Date:
- Fri Jun 03 19:05:10 2016 +0000
- Revision:
- 5:5d3dc5f8f7b4
- Parent:
- 4:4510b10fb5d9
- Child:
- 6:419eea2fe960
Added auto doc markups to new fxs
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
simon | 1:96ae39e58792 | 1 | /* mbed Terminal Library, for ANSI/VT200 Terminals and ecape codes |
simon | 2:85184c13476c | 2 | * Copyright (c) 2007-2010, sford, http://mbed.org |
simon | 1:96ae39e58792 | 3 | * |
simon | 1:96ae39e58792 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
simon | 1:96ae39e58792 | 5 | * of this software and associated documentation files (the "Software"), to deal |
simon | 1:96ae39e58792 | 6 | * in the Software without restriction, including without limitation the rights |
simon | 1:96ae39e58792 | 7 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
simon | 1:96ae39e58792 | 8 | * copies of the Software, and to permit persons to whom the Software is |
simon | 1:96ae39e58792 | 9 | * furnished to do so, subject to the following conditions: |
simon | 0:2bf27af3c759 | 10 | * |
simon | 1:96ae39e58792 | 11 | * The above copyright notice and this permission notice shall be included in |
simon | 1:96ae39e58792 | 12 | * all copies or substantial portions of the Software. |
simon | 1:96ae39e58792 | 13 | * |
simon | 1:96ae39e58792 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
simon | 1:96ae39e58792 | 15 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
simon | 1:96ae39e58792 | 16 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
simon | 1:96ae39e58792 | 17 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
simon | 1:96ae39e58792 | 18 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
simon | 1:96ae39e58792 | 19 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
simon | 1:96ae39e58792 | 20 | * THE SOFTWARE. |
simon | 0:2bf27af3c759 | 21 | */ |
simon | 0:2bf27af3c759 | 22 | |
simon | 0:2bf27af3c759 | 23 | #include "mbed.h" |
simon | 0:2bf27af3c759 | 24 | |
simon | 0:2bf27af3c759 | 25 | #ifndef MBED_TERMINAL_H |
simon | 0:2bf27af3c759 | 26 | #define MBED_TERMINAL_H |
simon | 0:2bf27af3c759 | 27 | |
simon | 2:85184c13476c | 28 | /** Control and display on an ANSI/VT100 Terminal |
simon | 2:85184c13476c | 29 | * |
simon | 2:85184c13476c | 30 | * This allows you to control an ANSI serial terminal |
simon | 2:85184c13476c | 31 | */ |
simon | 0:2bf27af3c759 | 32 | class Terminal : public Serial { |
simon | 0:2bf27af3c759 | 33 | public: |
simon | 1:96ae39e58792 | 34 | /** Create the Terminal interface |
simon | 1:96ae39e58792 | 35 | * |
simon | 1:96ae39e58792 | 36 | * @param tx Serial transmit |
simon | 1:96ae39e58792 | 37 | * @param rx Serial recieve |
simon | 1:96ae39e58792 | 38 | */ |
simon | 0:2bf27af3c759 | 39 | Terminal(PinName tx, PinName rx); |
simon | 0:2bf27af3c759 | 40 | |
simon | 1:96ae39e58792 | 41 | #if DOXYGEN_ONLY |
simon | 1:96ae39e58792 | 42 | /** Write a character to the terminal |
simon | 1:96ae39e58792 | 43 | * |
simon | 1:96ae39e58792 | 44 | * @param c The character to write to the display |
simon | 1:96ae39e58792 | 45 | */ |
simon | 1:96ae39e58792 | 46 | int putc(int c); |
simon | 0:2bf27af3c759 | 47 | |
simon | 1:96ae39e58792 | 48 | /** Write a formated string to the terminal |
simon | 1:96ae39e58792 | 49 | * |
simon | 1:96ae39e58792 | 50 | * @param format A printf-style format string, followed by the |
simon | 1:96ae39e58792 | 51 | * variables to use in formating the string. |
simon | 1:96ae39e58792 | 52 | */ |
simon | 1:96ae39e58792 | 53 | int printf(const char* format, ...); |
simon | 1:96ae39e58792 | 54 | |
simon | 1:96ae39e58792 | 55 | // also baud etc |
simon | 1:96ae39e58792 | 56 | #endif |
simon | 1:96ae39e58792 | 57 | |
simon | 1:96ae39e58792 | 58 | /** Locate to a screen column and row |
simon | 1:96ae39e58792 | 59 | * |
simon | 1:96ae39e58792 | 60 | * @param column The horizontal position from the left, indexed from 0 |
simon | 1:96ae39e58792 | 61 | * @param row The vertical position from the top, indexed from 0 |
simon | 1:96ae39e58792 | 62 | */ |
simon | 1:96ae39e58792 | 63 | void locate(int column, int row); |
simon | 1:96ae39e58792 | 64 | |
simon | 1:96ae39e58792 | 65 | /** Clear the screen and locate to 0,0 */ |
simon | 0:2bf27af3c759 | 66 | void cls(); |
j3 | 4:4510b10fb5d9 | 67 | |
j3 | 4:4510b10fb5d9 | 68 | void home(); |
simon | 1:96ae39e58792 | 69 | |
simon | 1:96ae39e58792 | 70 | /** Set the foreground colour */ |
simon | 0:2bf27af3c759 | 71 | void foreground(int colour); |
simon | 1:96ae39e58792 | 72 | |
simon | 1:96ae39e58792 | 73 | /** Set the background colour */ |
simon | 0:2bf27af3c759 | 74 | void background(int colour); |
j3 | 3:7c269f52ad77 | 75 | |
j3 | 5:5d3dc5f8f7b4 | 76 | /** Get integer value from user |
j3 | 5:5d3dc5f8f7b4 | 77 | * |
j3 | 5:5d3dc5f8f7b4 | 78 | * @param msg - User prompt |
j3 | 5:5d3dc5f8f7b4 | 79 | * @param min_val - minimum value of input range |
j3 | 5:5d3dc5f8f7b4 | 80 | * @param max_val - maximum value of input range |
j3 | 5:5d3dc5f8f7b4 | 81 | */ |
j3 | 3:7c269f52ad77 | 82 | int32_t get_int32(const char *msg, const int32_t min_val, const int32_t max_val); |
j3 | 3:7c269f52ad77 | 83 | |
j3 | 5:5d3dc5f8f7b4 | 84 | /** Get char value from user |
j3 | 5:5d3dc5f8f7b4 | 85 | * |
j3 | 5:5d3dc5f8f7b4 | 86 | * @param msg - User prompt |
j3 | 5:5d3dc5f8f7b4 | 87 | * @param min_val - minimum value of input range |
j3 | 5:5d3dc5f8f7b4 | 88 | * @param max_val - maximum value of input range |
j3 | 5:5d3dc5f8f7b4 | 89 | */ |
j3 | 3:7c269f52ad77 | 90 | char get_char(const char *msg, const char min_val, const char max_val); |
simon | 0:2bf27af3c759 | 91 | }; |
simon | 0:2bf27af3c759 | 92 | |
simon | 0:2bf27af3c759 | 93 | #endif |