Getting Started with VICREO Listener.

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 downloads

How does it work

  • Download and install VICREO-Listener app for your OS (Windows/OSX/Linux/RaspberryPi)
  • Check for the log in the app to see on which IP addresses the listener will react

Installation

Download 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)

Issues?

If you have any issues or suggestions, please create one over at GitHub: https://github.com/bitfocus/companion-module-vicreo-hotkey/issues

Usage

You’ll send an object to the listener. The application first looks at a key called

 "type"
.

The following types are available;

Password

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 send it valid.

To support older connection methods, leave the password empty in the Listener.

Example key press

For keypresses create a object like this;

{ "key":"c", "type":"press", "password":"d41d8cd98f00b204e9800998ecf8427e" }

Example key combination

{ "key":"tab", "type":"combination", "modifiers":["alt"], "password":"d41d8cd98f00b204e9800998ecf8427e" }

Example key trio

{ "key":"c", "type":"trio", "modifiers":["ctrl","shift"], "password":"d41d8cd98f00b204e9800998ecf8427e" }

Put the modifiers in an array.
Alt/option, command(win), Ctrl and Shift are supported.

Example open file

Open a file on the local system;

{ "type":"file","path":"C:/Barco/InfoT1413.pdf", "password":"d41d8cd98f00b204e9800998ecf8427e"}

Example shell

To perform a shell command on the system;

{ "type":"shell","shell":"dir", "password":"d41d8cd98f00b204e9800998ecf8427e"}

Example processOSX

{ "key":"tab", "type":"processOSX","processName":"Microsoft PowerPoint", "modifiers":["alt"], "password":"d41d8cd98f00b204e9800998ecf8427e"}

Example string message

{ "type":"string","msg":"C:/Barco/InfoT1413.pdf", "password":"d41d8cd98f00b204e9800998ecf8427e" }

Keys

The following keys are supported:

KeyDescriptionNotes
backspace
delete
enter
tab
escape
upUp arrow key
downDown arrow key
rightRight arrow key
leftLeft 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
printscreenNo Mac support
insertNo Mac support
audio_muteMute the volume
audio_vol_downLower the volume
audio_vol_upIncrease the volume
audio_playPlay
audio_stopStop
audio_pausePause
audio_prevPrevious Track
audio_nextNext Track
audio_rewindLinux only
audio_forwardLinux only
audio_repeatLinux only
audio_randomLinux only
numpad_0No Linux support
numpad_1No Linux support
numpad_2No Linux support
numpad_3No Linux support
numpad_4No Linux support
numpad_5No Linux support
numpad_6No Linux support
numpad_7No Linux support
numpad_8No Linux support
numpad_9No Linux support
lights_mon_upTurn up monitor brightnessNo Windows support
lights_mon_downTurn down monitor brightnessNo Windows support
lights_kbd_toggleToggle keyboard backlight on/offNo Windows support
lights_kbd_upTurn up keyboard backlight brightnessNo Windows support
lights_kbd_downTurn down keyboard backlight brightnessNo Windows support

FAQ

For mac, when you need the path of a file, right-click on the file and when you see the menu, press and hold Alt to be able to copy the full path.
Fill complete filepath without parentheses


For additional actions, please raise a feature request on GitHub.