Syntax

Methods

• Keyboard
  • Keys
  • setKeyboardDelay
  • keyTap
  • keyToggle
  • typeString
  • typeStringDelayed
• Mouse
  • setMouseDelay
  • moveMouse
  • moveMouseSmooth
  • mouseClick
  • mouseToggle
  • getMousePos
  • scrollMouse
• Screen
  • getPixelColor
  • getScreenSize
  • screen.capture
• Bitmap
  • Properties
  • colorAt

---

Keyboard

Keys

keyToggle and keyTap support for following keys.

Note: The names of the letter and number keys are the same as that single letter or digit. For example: b is the "b" key and 5 is the "5" key.

Key	Description	Notes
backspace
delete
enter
tab
escape
up	Up arrow key
down	Down arrow key
right	Right arrow key
left	Left arrow key
home
end
pageup
pagedown
f1
f2
f3
f4
f5
f6
f7
f8
f9
f10
f11
f12
command
alt
control
shift
right_shift
space
printscreen		No Mac support
insert		No Mac support
audio_mute	Mute the volume
audio_vol_down	Lower the volume
audio_vol_up	Increase the volume
audio_play	Play
audio_stop	Stop
audio_pause	Pause
audio_prev	Previous Track
audio_next	Next Track
audio_rewind		Linux only
audio_forward		Linux only
audio_repeat		Linux only
audio_random		Linux only
numpad_0		No Linux support
numpad_1		No Linux support
numpad_2		No Linux support
numpad_3		No Linux support
numpad_4		No Linux support
numpad_5		No Linux support
numpad_6		No Linux support
numpad_7		No Linux support
numpad_8		No Linux support
numpad_9		No Linux support
lights_mon_up	Turn up monitor brightness	No Windows support
lights_mon_down	Turn down monitor brightness	No Windows support
lights_kbd_toggle	Toggle keyboard backlight on/off	No Windows support
lights_kbd_up	Turn up keyboard backlight brightness	No Windows support
lights_kbd_down	Turn down keyboard backlight brightness	No Windows support

Up to date as of v0.4.4.

.setKeyboardDelay(ms)

Sets the delay in milliseconds to sleep after a keyboard event. This is 10ms by default.

Arguments

• ms - Time to sleep in milliseconds.

.keyTap(key, modifier)

Press a single key.

Arguments

• key - See keys.
• modifier (optional, string or array) - Accepts alt, command (win), control, and shift.

.keyToggle(key, down, modifier)

Hold down or release a key.

Arguments

• key - See keys.
• down - Accepts 'down' or 'up'.
• modifier (optional, string or array) - Accepts alt, command (mac), control, and shift.

.typeString(string)

Arguments

• string - The string to send.

.typeStringDelayed(string, cpm)

Arguments

• string - The string to send.
• cpm - Characters per minute.

Mouse

.setMouseDelay(ms)

Sets the delay in milliseconds to sleep after a mouse event. This is 10ms by default.

Arguments

• ms - Time to sleep in milliseconds.

.moveMouse(x, y)

Moves mouse to x, y instantly.

Arguments

• x
• y

Examples

var robot = require("robotjs");

//Move the mouse to 100, 100 on the screen. 
robot.moveMouse(100, 100);

.moveMouseSmooth(x, y)

Moves mouse to x, y human like.

Arguments

• x
• y

.mouseClick(button, double)

Clicks the mouse.

Arguments

• button (optional) - Accepts left, right, or middle. Defaults to left.
• double (optional) - Set to true to perform a double click. Defaults to false.

Examples

var robot = require("robotjs");

robot.mouseClick();

.mouseToggle(down, button)

Toggles mouse button.

Arguments

• down (optional) - Accepts down or up. Defaults to down.
• button (optional) - Accepts left, right, or middle. Defaults to left.

Examples

var robot = require("robotjs");

robot.mouseToggle("down");

setTimeout(function()
{
    robot.mouseToggle("up");

}, 2000);

.getMousePos()

Gets the mouse coordinates.

Return

Returns an object with keys x and y.

Examples

var robot = require("robotjs");

var mouse = robot.getMousePos();
console.log("Mouse is at x:" + mouse.x + " y:" + mouse.y);

.scrollMouse(magnitude, direction)

Scrolls the mouse either up or down.

Arguments

• magnitude - The amount to scroll.
• direction - Accepts down or up.

Examples

var robot = require("robotjs");

robot.scrollMouse(50, "up");

setTimeout(function()
{
    robot.scrollMouse(50, "down");
}, 2000);

Screen

.getPixelColor(x, y)

Gets the pixel color at x, y. This function is perfect for getting a pixel or two, but if you'll be reading large portions of the screen use screen.capture.

Arguments

• x
• y

Return

Returns the hex color code of the pixel at x, y.

.getScreenSize()

Gets the screen width and height.

Return

Returns an object with .width and .height.

.screen.capture

Gets part or all of the screen.

Arguments

• x (optional)
• y (optional)
• height (optional)
• width (optional)

If no arguments are provided, screen.capture will get the full screen.

Return

Returns a bitmap object.

Bitmap

This is an object returned by screen.capture.

Properties

• width - The width of the bitmap.
• height - The height of the bitmap.
• image - The raw image (buffer).
• byteWidth
• bitsPerPixel
• bytesPerPixel

.colorAt

Gets the pixel color at x, y of a bitmap.

Arguments

• x
• y

Return

Returns the hex color code of the pixel at x, y.

Examples

var robot = require("robotjs");

//Get a 100x100 screen capture starting at 0, 0. 
var img = robot.screen.capture(0, 0, 100, 100);

console.log(img.width)

//Get pixel color at 50, 50.
var hex = img.colorAt(50, 50);
console.log(hex);