diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-09-12 06:43:10 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-12 06:43:10 +0200 |
| commit | 7ad924bae5519e981c57495e481db62741aa4376 (patch) | |
| tree | e07575ee363f68b70579cda8e54eebcbd55d4127 /docs/feature_terminal.md | |
| parent | a4ff8b91f74df9fb1d87f52c0ded23935344d2eb (diff) | |
| download | qmk_firmware-7ad924bae5519e981c57495e481db62741aa4376.tar.gz qmk_firmware-7ad924bae5519e981c57495e481db62741aa4376.tar.xz | |
Updates send_string functionality, adds terminal feature (#1657)
* implement basic terminal stuff
* modify send_string to read normal strings too
* add files bc yeah. working pgm detected
* pgm detection apparently not working
* adds send string keycodes, additional keycode support in send string
* implement arguments
* [terminal] add help command
* [terminal] adds keycode and keymap functions
* [terminal] adds nop.h, documentation
* update macro docs
Diffstat (limited to 'docs/feature_terminal.md')
| -rw-r--r-- | docs/feature_terminal.md | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/docs/feature_terminal.md b/docs/feature_terminal.md new file mode 100644 index 000000000..2c5f2c486 --- /dev/null +++ b/docs/feature_terminal.md @@ -0,0 +1,80 @@ +# Terminal + +> This feature is currently *huge* at 4400 bytes, and should probably only be put on boards with a lot of memory, or for fun. + +The terminal feature is a command-line-like interface designed to communicate through a text editor with keystrokes. It's beneficial to turn off auto-indent features in your editor. + +To enable, stick this in your `rules.mk` or `Makefile`: + + TERMINAL_ENABLE = yes + +And use the `TERM_ON` and `TERM_OFF` keycodes to turn it on or off. + +When enabled, a `> ` prompt will appear, where you'll be able to type, backspace (a bell will ding if you reach the beginning and audio is enabled), and hit enter to send the command. Arrow keys are currently disabled so it doesn't get confused. Moving your cursor around with the mouse is discouraged. + +`#define TERMINAL_HELP` enables some other output helpers that aren't really needed with this page. + +## Future ideas + +* Keyboard/user-extendable commands +* Smaller footprint +* Arrow key support +* Command history +* SD card support +* LCD support for buffer display +* Keycode -> name string LUT +* Layer status +* *Analog/digital port read/write* +* RGB mode stuff +* Macro definitions +* EEPROM read/write +* Audio control + +## Current commands + +### `about` + +Prints out the current version of QMK with a build date: + +``` +> about +QMK Firmware + v0.5.115-7-g80ed73-dirty + Built: 2017-08-29-20:24:44 +``` + +### `help` + +Prints out the available commands: + +``` +> help +commands available: + about help keycode keymap exit +``` + +### `keycode <layer> <row> <col>` + +Prints out the keycode value of a certain layer, row, and column: + +``` +> keycode 0 1 0 +0x29 (41) +``` + +### `keymap <layer>` + +Prints out the entire keymap for a certain layer + +``` +> keymap 0 +0x002b, 0x0014, 0x001a, 0x0008, 0x0015, 0x0017, 0x001c, 0x0018, 0x000c, 0x0012, 0x0013, 0x002a, +0x0029, 0x0004, 0x0016, 0x0007, 0x0009, 0x000a, 0x000b, 0x000d, 0x000e, 0x000f, 0x0033, 0x0034, +0x00e1, 0x001d, 0x001b, 0x0006, 0x0019, 0x0005, 0x0011, 0x0010, 0x0036, 0x0037, 0x0038, 0x0028, +0x5cd6, 0x00e0, 0x00e2, 0x00e3, 0x5cd4, 0x002c, 0x002c, 0x5cd5, 0x0050, 0x0051, 0x0052, 0x004f, +> +``` + +### `exit` + +Exits the terminal - same as `TERM_OFF`.
\ No newline at end of file |