Skip to main content

Samples and supported key codes

Simulate HOME key​

key.press("HOMEBUTTON")

Simulate long-press HOME key​

key.down("HOMEBUTTON")
sys.msleep(1000)
key.up("HOMEBUTTON")

Simulate double-click HOME key​

key.press("HOMEBUTTON")
key.press("HOMEBUTTON")

Simulate Lock (power) key​

key.press("LOCK")

Simulate Return (Enter)​

key.press("RETURN")

Other samples​

-- Example: Command + V (paste). Note: it's Command on iOS, not Control.
key.down("LEFTCOMMAND")
sys.msleep(20)
key.press("V")
sys.msleep(20)
key.up("LEFTCOMMAND")
--
-- Example: Command + '[' go back
key.down("LEFTCOMMAND")
sys.msleep(20)
key.press("[")
sys.msleep(20)
key.up("LEFTCOMMAND")
--
-- Volume keys
key.press("VOLUMEUP")
key.press("VOLUMEDOWN")
--
key.down("VOLUMEUP")
sys.msleep(1000)
key.up("VOLUMEUP")
--
key.down("LOCK")
sys.msleep(3000)
key.up("LOCK")
--
key.press("SHOW_HIDE_KEYBOARD") -- hide software keyboard
--
key.press("SHOW_HIDE_KEYBOARD") -- show software keyboard
--
-- Screenshot: [Lock + Home]
key.down("LOCK")
sys.msleep(100)
key.press("HOMEBUTTON")
sys.msleep(100)
key.up("LOCK")
--
-- Switch IME on iOS 7/8: Command + Space
key.down("LEFTCOMMAND")
sys.msleep(50)
key.press(" ")
sys.msleep(50)
key.up("LEFTCOMMAND")
--
-- Switch IME on iOS 9: Control + Space
key.down("LEFTCONTROL")
sys.msleep(50)
key.press("SPACE")
sys.msleep(50)
key.up("LEFTCONTROL")

Note: uses non-chapter API sys.msleep

Supported key codes​

-- Letters:
"A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z"
--
-- Digits:
"1" "2" "3" "4" "5" "6" "7" "8" "9" "0"
--
-- Function keys:
"F1" "F2" "F3" "F4" "F5" "F6" "F7" "F8" "F9" "F10" "F11" "F12"
--
-- Others:
"RETURN"        -- Enter
"ESCAPE"        -- Esc
"BACKSPACE"     -- Backspace
"TAB"           -- Tab
"SPACE"         -- Space
"HYPHEN"        -- '-' or '_'
"EQUAL"         -- '=' or '+'
"BRACKETOPEN"   -- '[' or '{'
"BRACKETCLOSE"  -- ']' or '}'
"BACKSLASH"     -- '\\' or '|'
"SEMICOLON"     -- ';' or ':'
"QUOTATION"     -- quote/double-quote
"ACCENT"        -- '`' or '~'
"COMMA"         -- ',' or '<'
"DOT"           -- '.' or '>'
"SLASH"         -- '/' or '?'
"CAPSLOCK"      -- Caps Lock
"PAUSE"
"INSERT"
"HOME"          -- Not equal to iOS device HOME key
"PAGEUP"
"DELETE"
"END"
"PAGEDOWN"
"RIGHTARROW"    -- Right arrow
"LEFTARROW"     -- Left arrow
"DOWNARROW"     -- Down arrow
"UPARROW"       -- Up arrow
"LEFTCONTROL"   -- Left Ctrl
"LEFTSHIFT"     -- Left Shift
"LEFTALT"       -- Left Alt
"LEFTCOMMAND"   -- Left Command
"RIGHTCONTROL"  -- Right Ctrl
"RIGHTSHIFT"    -- Right Shift
"RIGHTALT"      -- Right Alt
"RIGHTCOMMAND"  -- Right Command
"LOCK"          -- Lock/Power
"HOMEBUTTON"    -- This equals iOS device HOME key
"FORWARD"       -- Media next
"REWIND"        -- Media previous
"FORWARD2"      -- Media next 2
"REWIND2"       -- Media previous 2
"EJECT"
"PLAYPAUSE"     -- Media pause
"MUTE"          -- Mute
"VOLUMEUP"      -- Volume +
"VOLUMEDOWN"    -- Volume -
"SPOTLIGHT"     -- Spotlight
"BRIGHTUP"      -- Brightness +
"BRIGHTDOWN"    -- Brightness -
"SHOW_HIDE_KEYBOARD" -- Show/Hide software keyboard