An Entertainment Control Interface
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kevin Matz a8265644c8 remove unnecessary header includes 4 months ago
src remove unnecessary header includes 4 months ago
.gitignore Initial commit 2 years ago
.gitmodules new urls for submodules 4 months ago
LICENSE reformatted LICENSE 2 years ago
README.md spelling and lint checking 1 year ago
vsKramer.pro use ordered CONFIG directive to fix build dependencies 4 months ago

README.md

vsKramer

An Entertainment Control Interface

Using either Art-Net, sACN, or a USB widget, vsKramer will interpret a DMX universe and map values and actions to OSC messages.

Audio input is also supported through the Lloyd audio level trigger provided by libZordon.

Usage

  1. Configure Triggers.

    • Select the serial Port of the Enttec DMX USB Pro Widget.
    • Configure the Net and Universe of the incoming ArtNet. Values are index-origin = 0
    • Configure the Universe of the incoming sACN. Value is index-origin = 1
  2. Configure OSC Server. Configure the address and port of the OSC server.

  3. Configure Paths. Verify the OSC client configuration table for DMX Faders and Audio Input.

  4. Monitor Inputs. Use the monitors to observe the status of configured input triggers.

Howto

  • Disable a Trigger: Set the slot to “0” for the trigger that you wish to disable. This will also disable the “GO” command for that trigger.

  • Disable a GO: Set the threshold to “256” for the trigger that you wish to disable.

Hog4 OSC Mappings

Always refer to the Hog 4 manual for the latest OSC mappings.

Playback Mapping

Hog 4 OS uses the following OSC paths and commands for sending and receiving playback messages:

Command OSC Path Data
Go a Cuelist / hog / playback / go / 0 cuelist #
Go a specific cue in a list (goto) / hog / playback / go / 0 cuelist #.cue #
Halt a Cuelist / hog / playback / halt / 0 cuelist #
Resume a halted cuelist / hog / playback / resume / 0 cuelist #
Release a Cuelist / hog / playback / release / 0 cuelist #
Go a Scene / hog / playback / go / 1 scene #
Halt a Scene / hog / playback / halt / 1 scene #
Release a Scene / hog / playback / release / 1 scene #
Go a Macro / hog / playback / go / 2 macro #
Halt a Macro / hog / playback / halt / 2 macro #
Release a Marco / hog / playback / release / 2 macro #

Midi Note Mappings

Hog 4 OS uses the following OSC paths and commands for receiving Midi Note input:

For example, the Hog 4 OS recognizes / hog / midi / on / 1 / 10 as a “note on” command for note 10 on channel 1

Command OSC Path Data
Midi Note On / hog / midi / on / channel # / note # velocity (if velocity = 0, then mesage is treated as note off)
Midi Note Off / hog / midi / off / channel # / note # velocity

Hardware Mappings

Hog 4 OS uses the following OSC paths and commands for receiving hardware messages (faders and encoders not supported on Hog 4 PC unless a Hog 4 Series wing is attached):

For keys not listed in the table below the OSC path is hog/hardware/button name as listed on the front panel.

For paths that contain “master #” use the master number for the front panel hardware you are trying to control. Master numbers 1 thru 90 are supported.

For example, to press the go button on the console’s front panel for master 6 the OSC path is hog / playback / go / 6

Command OSC Path Data
Choose Keys / hog / hardware / choose / master # 0 = button up, 1 = button down
Go Keys / hog / hardware / go / master # 0 = button up, 1 = button down
Pause Keys / hog / hardware / pause / master # 0 = button up, 1 = button down
Back Keys / hog / hardware / goback / master # 0 = button up, 1 = button down
Flash Keys / hog / hardware / flash / master # 0 = button up, 1 = button down
Faders / hog / hardware / fader / master # 0 < 255 discreet fader value
Grand Master / hog / hardware / fader / 0 0 < 255 discreet fader value
Encoders / hog / hardware / encoderwheel / # -20 < 20 variable value
Encoder Wheel Buttons / hog / hardware / ewheelbutton / # 0 = button up, 1 = button down
Rate Wheel / hog / hardware / ratewheel -20 < 20 variable value
i-Wheel / hog / hardware / iwheel -20 < 20 variable value
i-Wheel Up Button / hog / hardware / iwheelup 0 = button up, 1 = button down
iWheel Down Button / hog / hardware / iwheeldown 0 = button up, 1 = button down
Pig Key / hog / hardware / pig 0 = button up, 1 = button down
Trackball POS Mode / hog / hardware / posmode 0= toggle off, 1 = toggle on
Trackball Position Value / hog / hardware / trackball X,Y values
. Key / hog / hardware / period 0 = button up, 1 = button down
0 key / hog / hardware / zero 0 = button up, 1 = button down
1 key / hog / hardware / one 0 = button up, 1 = button down
2 key / hog / hardware / two 0 = button up, 1 = button down
3 key / hog / hardware / three 0 = button up, 1 = button down
4 key / hog / hardware / four 0 = button up, 1 = button down
5 key / hog / hardware / five 0 = button up, 1 = button down
6 key / hog / hardware / six 0 = button up, 1 = button down
7 key / hog / hardware / seven 0 = button up, 1 = button down
8 key / hog / hardware / eight 0 = button up, 1 = button down
9 key / hog / hardware / nine 0 = button up, 1 = button down
Arrow Up key / hog / hardware / up 0 = button up, 1 = button down
Arrow Down key / hog / hardware / down 0 = button up, 1 = button down
Arrow Left key / hog / hardware / left 0 = button up, 1 = button down
Arrow Right key / hog / hardware / right 0 = button up, 1 = button down
@ key / hog / hardware / at 0 = button up, 1 = button down
- key / hog / hardware / minus 0 = button up, 1 = button down
+ key / hog / hardware / plus 0 = button up, 1 = button down
/ key / hog / hardware / slash 0 = button up, 1 = button down
backspace key / hog / hardware / backspace 0 = button up, 1 = button down
H keys (function keys) / hog / hardware / h# 0 = button up, 1 = button down
Main Play key / hog / hardware / maingo 0 = button up, 1 = button down
Main Pause key / hog / hardware / mainhalt 0 = button up, 1 = button down
Main Back key / hog / hardware / mainback 0 = button up, 1 = button down
Center Choose key / hog / hardware / mainchoose 0 = button up, 1 = button down
Skip Forward / hog / hardware / skipfwd 0 = button up, 1 = button down
Skip Back / hog / hardware / skipback 0 = button up, 1 = button down

vsKramer

Copyright © 2014, 2016 Kevin Matz (kevin.matz@gmail.com) All Rights Reserved.

vsKramer is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.

vsKramer is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with vsKramer. If not, see http://www.gnu.org/licenses/.

Others

Hog4, the Hog4 logo, and the Hog 4 OSC mappings are trademarked, copyright, registered, or otherwise protected intellectual property of High End Systems, and ETC Company. Used and/or communicated here under fair use.