VICREO Listener is a small program that sits on your machine waiting for incoming TCP connection/commands. It uses pre-defined commands to simulate key-presses on your machine. You can use this program to preform hotkey actions from remote
Straight to downloadsDownload the right software package for your operating system and launch the program on the machine you would like to control (host).
On your client machine (the one you are sending commands from), send TCP string to the right IP-address from the host, to port 10001 (or change the port to something you like)
If you have any issues or suggestions, please create one over at GitHub: https://github.com/bitfocus/companion-module-vicreo-hotkey/issues
You’ll send an object to the listener. The application first looks at a key called
"type"
.The following types are available;
As from version 3.0.0 its needed to at a password option when sending your object. When in the listener the password is not filled, you can send an empty password. When a password is filled, you will need to Hash the password (MD5 hash) so the listener can check that the object is valid.
To support older connection methods, leave the password empty in the Listener.
For keypresses create a object like this;
{ "key":"c", "type":"press", "password":"d41d8cd98f00b204e9800998ecf8427e" }
{ "key":"tab", "type":"combination", "modifiers":["alt"], "password":"d41d8cd98f00b204e9800998ecf8427e" }
{ "key":"left", "type":"trio", "modifiers":["ctrl","shift"], "password":"d41d8cd98f00b204e9800998ecf8427e" }
Put the modifiers in an array.
Alt/option, command(win), Ctrl and Shift are supported.
{ "key":"tab", "type":"processOSX","processName":"Microsoft PowerPoint", "modifiers":["alt"], "password":"d41d8cd98f00b204e9800998ecf8427e"}
{ "type":"string","msg":"C:/Barco/InfoT1413.pdf", "password":"d41d8cd98f00b204e9800998ecf8427e" }
Open a file on the local system;
{ "type":"file","path":"C:/Barco/InfoT1413.pdf", "password":"d41d8cd98f00b204e9800998ecf8427e"}
To perform a shell command on the system;
{ "type":"shell","shell":"dir", "password":"d41d8cd98f00b204e9800998ecf8427e"}
To set the mouse to a certain place
{ "type":"mousePosition","x":"500","y":"500", "password":"d41d8cd98f00b204e9800998ecf8427e"}
Click the mouse, provide button (left, right), double (true for double click)
{ "type":"mouseClick","button":"left","double":"false", "password":"d41d8cd98f00b204e9800998ecf8427e"}
Subscribe to certain events
{ "type":"subscribe","name":"mousePosition", "password":"d41d8cd98f00b204e9800998ecf8427e"}
Unsubscribe to certain events
{ "type":"unsubscribe","name":"mousePosition", "password":"d41d8cd98f00b204e9800998ecf8427e"}
The following keys are supported:
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 |