KeyBridgeV2

(Version v2.0.0)

Development status: concept

core to control SKAARHOJ KeyBridge V2

ParameterCount: 9

View modernized layout

Model:
ParameterClass:
ParameterKeyBridgeV2 Server (1)
KeybridgeV2 Server Application running on Mac, Windows or Linux, download from skaarhoj.com
Development Status: concept
(9 params)
USB Keyboard & Mouse (2)
Direct USB connection to the computer plugged into this device's Micro-USB port. Requires USB Keyboard & Mouse to be enabled in Settings -> Advanced System Settings -> Micro-USB Functions.
Development Status: concept
(9 params)
config
Connected
Connection status of device
connection
Control:
-
Feedback:
Binary
keyboard
ParameterKeyBridgeV2 ServerUSB Keyboard & Mouse
Trigger Key
Send a keystroke to the connected machine. Set the key, optionally the modifiers to hold with it, and optionally a hold duration.
trigger_key
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
duration (Type Integer): Optional hold duration in milliseconds. 0 (default) sends a simple tap, maximum 30000
key (Type String): Name of the key to press
modifiers (Type String): Optional modifier keys to hold with the key, separated by commas, e.g. cmd,shift. Available: cmd, ctrl, alt, shift (cmd is the Windows key on Windows, alt is Option on a Mac)
SimpleParam
Type Text
Type a piece of text on the connected computer, exactly as written. The computer must be set to the keyboard layout configured for this device, and every character has to exist on that layout. To press a single key or a shortcut, use Trigger Key.
type_text
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
text (Type String): The text to type, at most 500 characters
SimpleParam
mouse
ParameterKeyBridgeV2 ServerUSB Keyboard & Mouse
Mouse Click
Click a mouse button on the connected computer. The click lands wherever the cursor already is - a USB mouse cannot be told to go to a position first.
mouse_click
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
button (Type Options): Mouse button to click (default left)
x (Type Integer): mouse X coordinate, if -1 uses current position
y (Type Integer): mouse Y coordinate, if -1 uses current position
SimpleParam
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
button (Type Options): Mouse button to click (default left)
x (Type Integer): Ignored over USB
y (Type Integer): Ignored over USB
SimpleParam
Mouse Move
Move the cursor on the connected computer by a relative distance. A USB mouse reports movement, not position, so an absolute move is applied as a relative one and the relative flag makes no difference.
mouse_move
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
relative (Type Boolean): Whenever to use relative movements or perform an absolute move
x (Type Integer): mouse move X coordinate or relative distance
y (Type Integer): mouse move Y coordinate or relative distance
SimpleParam
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
relative (Type Boolean): Ignored over USB: movement is always relative
x (Type Integer): horizontal distance to move, in pixels
y (Type Integer): vertical distance to move, in pixels
SimpleParam
Mouse Scroll
Turn the scroll wheel on the connected computer, wherever the cursor already is.
mouse_scroll
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
delta_x (Type Integer): horizontal scroll amount
delta_y (Type Integer): vertical scroll amount (negative scrolls down)
x (Type Integer): mouse X coordinate, if -1 uses current position
y (Type Integer): mouse Y coordinate, if -1 uses current position
SimpleParam
Control:
One-Shot Trigger
Feedback:
-

MetaValues:
delta_x (Type Integer): Ignored over USB: the gadget mouse has one wheel axis
delta_y (Type Integer): vertical scroll amount (negative scrolls down)
x (Type Integer): Ignored over USB
y (Type Integer): Ignored over USB
SimpleParam
Mouse Speed X
Drive the cursor horizontally at a speed, for mapping to a joystick axis. Positive moves right, 0 stops. The maximum speed in pixels per second is set per device in the core configuration.
mouse_speed_x
Control:
Integer [-100:100]%
Feedback:
-
SimpleParam
Mouse Speed Y
Drive the cursor vertically at a speed, for mapping to a joystick axis. Positive moves down, 0 stops. The maximum speed in pixels per second is set per device in the core configuration.
mouse_speed_y
Control:
Integer [-100:100]%
Feedback:
-
SimpleParam
tests
ParameterKeyBridgeV2 ServerUSB Keyboard & Mouse
Status Test
Test the USB connection: checks that a computer is attached to the Micro-USB port and spins the cursor in a circle on it
status_test
Control:
One-Shot Trigger
Feedback:
String