Keyboard and Mouse Input Simulation for Windows OS

Description

Control your keyboard and mouse with R code by simulating key presses and mouse clicks. The input simulation is implemented with the Windows API.

Author(s)

Maintainer: Jim Chen jim71183@gmail.com

Authors:

• Jeff Keller github@vtkellers.com [contributor]

Other contributors:

• Garry Hopwood garryhopwood@hotmail.com [contributor]

• Chieh Hsu tiff103012345@gmail.com [contributor]

See Also

Useful links:

• https://github.com/ChiHangChen/KeyboardSimulator

• Report bugs at https://github.com/ChiHangChen/KeyboardSimulator/issues

Simulate Key Press

Description

Simulate keyboard key presses. Multiple keys can be pressed simultaneously by using + as separator (see Examples). See keyboard_value for supported keys.

Usage

keybd.press(button, hold = FALSE)

Arguments

See Also

keybd.release

Examples

## Not run: 

# press one key
keybd.press("a")

# press multiple keys
keybd.press("Alt+F4")

# press multiple keys using hold
keybd.press("Alt", hold = TRUE)
keybd.press("F4")
keybd.release("Alt")

## End(Not run)

Simulate Key Release

Description

Simulate the release of keyboard keys held by keybd.press. Multiple keys can be released simultaneously by using a + separator (see Examples). See keyboard_value for supported keys.

Usage

keybd.release(button)

Arguments

See Also

keybd.press

Examples

## Not run: 

# Move to the third working window
keybd.press("Alt", hold = TRUE)
keybd.press("Tab")
Sys.sleep(0.1)
keybd.press("Tab")
keybd.release("Alt")

## End(Not run)

Type a raw string

Description

Type a raw string base on a given string.

Usage

keybd.type_string(string)

Arguments

Examples

## Not run: 

# Type 'Hello world!'
keybd.type_string("Hello world!")

## End(Not run)

keyboard_value

Description

List of supported keyboard keys, along with their virtual-key and hardware scan codes. A field indicating whether the key is an "extended key" with a 0xE0 prefix byte is also included to differentiate between duplicate keys on the keyboard and num pad. For example, while the 1 key usually behaves the same as the 1 key on the num pad, some applications see these as two distinct keys.

Usage

keyboard_value

Format

An object of class data.frame with 137 rows and 5 columns.

Details

Supported keys:

• 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

• 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

• 0

• 1

• 2

• 3

• 4

• 5

• 6

• 7

• 8

• 9

• num0

• num1

• num2

• num3

• num4

• num5

• num6

• num7

• num8

• num9

• f1

• f2

• f3

• f4

• f5

• f6

• f7

• f8

• f9

• f10

• f11

• f12

• backspace

• tab

• enter

• shift

• ctrl

• alt

• capslock

• esc

• pageup

• pagedown

• end

• home

• left

• up

• right

• down

• insert

• space

• del

• numlock

• win

• '

• ~

• !

• @

• #

• $

• %

• ^

• &

• *

• (

• )

• -

• _

• +

• =

• [

• {

• ]

• }

• \

• |

• ;

• :

• '

• "

• ,

• <

• .

• >

• /

• ?

References

Hardware Scan Codes, Virtual-Key Codes

Simulate Mouse Clicks

Description

Simulate left, right, and middle mouse clicks.

Usage

mouse.click(button = "left", hold = FALSE)

Arguments

See Also

mouse.release

Examples

## Not run: 

# left mouse click
mouse.click(button = "left")

# left mouse click and hold
mouse.click(button = "left", hold = TRUE)

## End(Not run)

Get Current Cursor Coordinate

Description

Get current cursor coordinate of screen .

Usage

mouse.get_cursor()

Examples

## Not run: 

mouse.get_cursor()

## End(Not run)

Move Cursor to Specific Location

Description

Move cursor to specific coordinate of screen .

Usage

mouse.move(x, y, duration = NA, step_ratio = 0.01)

Arguments

Examples

## Not run: 

# Move cursor to middle of screen in 1080FHD monitor
mouse.move(x = 960, y = 540)

# Move cursor to middle of screen in 1080FHD monitor within 3 seconds
mouse.move(x = 960, y = 540, duration = 3)

## End(Not run)

Simulate Mouse Click Release

Description

Simulate the release of mouse button held by mouse.click.

Usage

mouse.release(button = "left")

Arguments

See Also

mouse.click

Examples

## Not run: 

# right mouse click and hold
mouse.click(button = "right", hold = TRUE)

# release right click
mouse.release(button = "right")

## End(Not run)