# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1521164828 0
# Node ID 5e91b1c107ebbb2a2156af2f762ea5a07b59dbf9
# Parent  8c7e86bc137e4c94051e1a88bd3d633cd99281c2
fc-shell help file: documented key, keydown and keyup commands

diff -r 8c7e86bc137e -r 5e91b1c107eb rvinterf/asyncshell/helpfile
--- a/rvinterf/asyncshell/helpfile	Fri Mar 16 00:52:40 2018 +0000
+++ b/rvinterf/asyncshell/helpfile	Fri Mar 16 01:47:08 2018 +0000
@@ -6,6 +6,9 @@
 disable		Disable receiving and display of certain packet types
 enable		Enable receiving and display of certain packet types
 exit		Exit from fc-shell
+key		Send keystroke event to UI firmware on the target
+keydown		Send key down event to UI firmware on the target
+keyup		Send key up event to UI firmware on the target
 poweroff	Send power-off ETM command packet to the target
 quit		Alias for exit
 send		Send arbitrary RVTMUX packet to the target
@@ -46,6 +49,39 @@
 === quit
 This command is self-explanatory.
 
+=== key
+key <key-sequence>
+
+This command sends a GPF system primitive to the MMI entity in the target
+firmware that encodes a simulated keystroke or a sequence of simulated
+keystrokes.  Digits 0-9 are sent naturally, star and hash keys are sent as
+'*' and '#' ASCII characters, and the remaining keys on the D-Sample keypad
+are encoded as short all-uppercase ASCII strings as follows:
+
+UP, DOWN, LEFT, RIGHT and CENTER: directional keys
+LSOFT and RSOFT: "soft left" and "soft right" keys directly under the LCD
+SEND and END: green and red keys, respectively
+VOL_PLUS, VOL_MINUS and EXTRA: the 3 side buttons on the D-Sample handset
+
+Both single-character and long-named keys can be run together, for example:
+
+key RSOFT*	-- keypad lock or unlock sequence
+key 5551212SEND	-- enter digits 5551212, then SEND button to start the call
+
+=== keydown
+=== keyup
+keydown <key-name>
+keyup <key-name>
+
+The basic key command sends a KEY_SEQUENCE command (encoded via a GPF CONFIG
+system primitive) to the MMI entity in the target firmware; TI's firmware
+implementation then generates first a key down event, then a key up event for
+each key in the transmitted sequence.  TI's firmware also supports similarly-
+encoded KEY_PRESS and KEY_RELEASE commands which generate only a single key down
+or key up event, respectively; our keydown and keyup commands provide access to
+this functionality.  Only single keys can be sent with these commands, not
+sequences.
+
 === poweroff
 This command sends a power-off request in the form of an ETM ABB register write
 command packet to the target.