{"id":3292,"date":"2025-04-13T19:52:03","date_gmt":"2025-04-13T19:52:03","guid":{"rendered":"https:\/\/devicejockey.de\/?page_id=3292"},"modified":"2026-01-03T12:15:25","modified_gmt":"2026-01-03T12:15:25","slug":"scripts","status":"publish","type":"page","link":"https:\/\/devicejockey.de\/?page_id=3292","title":{"rendered":"Scripts"},"content":{"rendered":"

[vc_row el_class=”welcomebox” css=”.vc_custom_1707149624705{margin-bottom: 20px !important;padding-bottom: 5px !important;}”][vc_column][vc_row_inner][vc_column_inner width=”1\/2″][vc_column_text css=””]<\/p>\n

Scripts<\/h1>\n

[\/vc_column_text][\/vc_column_inner][\/vc_row_inner][vc_column_text css=””]Bring your panel to the next level with the power of JavaScript![\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1707045863978{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox” el_id=”interfaces”][vc_column][vc_column_text css=””]<\/p>\n

With scripts in Commands<\/strong> and Events<\/strong>, you can run simple JavaScript code.
You have access to all Swaps<\/strong> inside your script and can use them like variables \u2013 just refer to the exact name.<\/p>\n

[\/vc_column_text][vc_message message_box_color=”success” icon_fontawesome=”fa fa-solid fa-hand-point-up” css=””]Using \\(swapname)<\/code> is also possible, but before execution it will be replaced with the current value of the swap.[\/vc_message][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1703005440459{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]<\/p>\n

Command Script<\/h1>\n

[\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1703005440459{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]A command script is executed when the command<\/strong> is triggered.
The output of the script is ignored<\/strong> \u2013 command scripts are not used to control an item directly.
Instead, they typically update Swaps and control other elements of the panel.[\/vc_column_text][vc_column_text css=””]<\/p>\n

Send Local Command<\/h2>\n

You can send a local value command directly from any command script.<\/p>\n

[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n

sendCommand(\"\/test\", \"Hello\") \/\/ sends \"Hello\" to \/test\r\nsendCommand(\"\/test\", 10) \/\/ sends 10 to \/test\r\nsendCommand(\"\/test\", 10, \"float\") \/\/ sends 10 as float to \/test\r\nsendCommand(\"\/test\", 10.5, \"int\") \/\/ sends 10 as int to \/test\r\nsendCommand(\"\/test\", 1, \"bool\") \/\/ sends true as bool to \/test\r\nsendCommand(\"\/test\", true, \"bool\") \/\/ sends true as bool to \/test<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
Art-Net Commands<\/h2>\n
When using Art-Net interfaces, an Art-Net script command allows you to update DMX channel values.[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
sendArtNet(128, 1) \/\/ updates channel 1 to 128 in 8Bit\r\nsendArtNet(128, 1, 2) \/\/ updates channels 1 and 2 to 128 16-bit. Decimal places are possible.\r\n<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
OSC Commands<\/h2>\n
OSC Out interfaces and Behringer\/Midas interfaces allow you to send OSC commands using OSC Script or BX Script commands.[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
\/\/ Send OSC command:\r\nlet arguments = [[\"Example\"], [10, \"int32\"], [20, \"float\"], [true, \"bool\"]]\r\nsendOSC(\"\/test\", arguments)<\/pre>\n
[\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1703005440459{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]<\/p>\n
Event Script<\/h1>\n
[\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1707045863978{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]Event scripts run automatically. For example, when switching to Live Mode, powering up Interfaces, or whenever a Swap used in the script changes. The return value of the script is used to control the item.<\/p>\n
The following example sets a slider to the middle position:[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
let slider = 0.5\r\nslider \/\/ this sets the slider to the middle<\/pre>\n
[\/vc_column_text][vc_column_text css=””]You could also write this shorter:[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
0.5 \/\/ sets the slider directly<\/pre>\n
[\/vc_column_text][vc_column_text css=””]Or use a more complex calculation:[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
if (DLY_MidiSync == 1) {\r\n  let time = 60 \/ midiBPM\r\n  let range = 3\r\n  let sliderValue = time \/ range\r\n  sliderValue\r\n}<\/pre>\n
[\/vc_column_text][vc_message message_box_color=”success” icon_fontawesome=”fa fa-solid fa-hand-point-up” css=””]If the script returns nothing<\/strong>, the item will not be affected. This gives you control over whether the item should be influenced by the script or not.[\/vc_message][vc_column_text css=”” el_class=”codebox”]<\/p>\n
void 0 \/\/ use this line to return \"nothing\"<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
Local Events<\/h2>\n
An event script can respond to local events.
\nUse the function getEventValue(path)<\/strong>, where path is the local event\u2019s path.
\nYou\u2019ll receive the value that was sent to that path.[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
let value = getEventValue(\"\/test\") \/\/ get the value sent by \"\/test\"\r\n\r\n\/\/ Checking whether you have received a value from \"\/test\" before reacting is important!<\/span>\r\nif (typeof value !== \"undefined\") {\r\n   \/\/ value received from that path\r\n} else {\r\n   \/\/ no value received from that path\r\n}<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
Remote Options<\/h2>\n
Inside your script, you can also configure remote options<\/strong>, which determine which commands should be triggered by this event script:<\/p>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
remote(\"all\", true) \/\/ enables \"send all triggers\"\r\nremote(\"all\", false) \/\/ disables all\r\nremote(\"d\", true\/false) \/\/ sets \"disable control\"\r\nremote(\"s\", true\/false) \/\/ sets \"system event\"\r\nremote(\"1\"..\"20\", true\/false) \/\/ enables or disables trigger 1\u201320<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
Set Item Color<\/h2>\n
Set the color of your Item with the following functions:<\/p>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
\/\/ RGB\r\n\r\n\/\/ background color\r\nlet red = 255 \/\/ 0..255\r\nlet green = 0 \/\/ 0..255\r\nlet blue = 0 \/\/ 0..255\r\n\r\n\/\/ optional textcolor\r\nlet redTxt = 255 \/\/ 0..255\r\nlet greenTxt = 0 \/\/ 0..255\r\nlet blueTxt = 0 \/\/ 0..255\r\n\r\nsetColorRGB(red, green, blue) \/\/ colors only the Item\r\nsetColorRGB(red, green, blue, redTxt, greenTxt, blueTxt) \/\/ colors the Item and the text\r\n\r\n\/\/ HSL\r\n\r\n\/\/ background color\r\nlet hue = 360 \/\/ 0..360\r\nlet saturation = 100 \/\/ 0..100\r\nlet lightness = 50 \/\/ 0..100\r\n\r\n\/\/ optional textcolor\r\nlet hueTxt = 360 \/\/ 0..360\r\nlet saturationTxt = 100 \/\/ 0..100\r\nlet lightnessTxt = 50 \/\/ 0..100\r\n\r\nsetColorHSL(hue, saturation, lightness, hueTxt, saturationTxt, lightnessTxt) \/\/ colors the Item and the text\r\nsetColorHSL(hue, saturation, lightness) \/\/ colors only the Item<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
Behringer\/Midas and OSC Label<\/h2>\n
In the Label Event of the Behringer\/Midas and the OSC interface, you can format the incoming arguments using a script.
\nThe first received argument is available as labelValue<\/strong>. Get all arguments as an array with oscArguments<\/strong>.<\/p>\n
The output of your script will be displayed as the label.<\/p>\n
Example<\/h3>\n
Converting a value from 0\u20131 into a frequency from 200 Hz to 20 kHz.
\nYou will get 200 to 999, 1k, 1.5k, 20k[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
const maxF = 20000\r\nconst minF = 200\r\nconst x = Math.min(Math.max(0.0, labelValue), 1.0)\r\nconst m = maxF \/ minF\r\nconst frequency = minF * Math.pow(10.0, x * Math.log10(m))\r\n\r\nformatFrequency(frequency)\r\n\r\nfunction formatFrequency(frequency) {\r\n   if (frequency < 1000) {\r\n     return Math.round(frequency).toString()\r\n   } else {\r\n     const k = frequency \/ 1000\r\n     const rounded = Math.round(k * 10) \/ 10\r\n     return (rounded % 1 === 0 ? rounded.toFixed(0) : rounded.toFixed(1)) + 'k'\r\n   }\r\n}<\/pre>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
console.log(oscArguments) \/\/ Print all received arguments in the logging view<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
Behringer\/Midas and OSC Script<\/h2>\n
Process the OSC event in the script. You can access the received arguments with the oscArguments<\/strong> array.[\/vc_column_text][vc_column_text css=””]<\/p>\n
MIDI Clock<\/h2>\n
With the MIDI In interface, you can use a script inside the MIDI Clock event to process MIDI Clock data.[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
midiBar \/\/ current bar\r\nmidiBeat \/\/ current beat\r\nmidiBPM \/\/ current BPM\r\nmidiStarted \/\/ true if clock started from stop\r\nmidiStopped \/\/ true if clock stopped\r\nmidiContinued \/\/ true if clock continued from pause<\/pre>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
console.log(swapA) \/\/ shows \"swapB\"\r\nconsole.log(getSwapValue(swapA)) \/\/ shows 10<\/pre>\n
[\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1703005440459{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]<\/p>\n
Swaps In Scripts<\/h1>\n
[\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1703005440459{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]You can use swaps in scripts in two ways:<\/p>\n
Swap Name<\/h3>\n
Use the swap name directly to read or change a swap\u2019s value.[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]console.log(mySwap) \/\/ The value of the swap, e.g. 10 or “Hello”<\/p>\n
mySwap = “Hello world” \/\/ Sets the value of the swap to “Hello world”[\/vc_column_text][vc_column_text css=””]<\/p>\n
Escaped Swap \\(swapName)<\/code><\/h3>\n
Use the escaped swap name if you want to replace part of the script with the swap\u2019s value.<\/p>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]console.log( “Hello \\(mySwap)” ) \/\/ “Hello world”[\/vc_column_text][vc_column_text css=””]<\/p>\n
Swap Values<\/h3>\n
[\/vc_column_text][vc_message message_box_color=”success” icon_fontawesome=”fa fa-solid fa-hand-point-up” css=””]A swap can contain another swap as its value.[\/vc_message][vc_column_text css=””]<\/p>\n
Example<\/h3>\n
swapA = \\(swapB)
\nswapB = 10<\/p>\n
You always get the swap value when you use the variable name.
\nUse the getSwapValue()<\/strong> function to retrieve the fully replaced value.[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]console.log(swapA) \/\/ Prints \\(swapB)<\/p>\n
console.log( getSwapValue(swapA) \/\/ Prints 10[\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1703005440459{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]<\/p>\n
Functions And Variables in Scripts<\/h1>\n
[\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1703005440459{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox”][vc_column][vc_column_text css=””]<\/p>\n
Item Status<\/h2>\n
Retrieve the item status in a script.
\nAll variables are read-only. The item status can not be set.
\nDepending on the item type, some values \u200b\u200bmay not be available.<\/p>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
itemValue \/\/ e.g. slider position (0\u20131) or toggle state (0 = off, 1 = on)\r\nitemSelected \/\/ true for toggled on, false for off\r\nitemLight \/\/ true if item\u2019s light is on\r\nitemProtected \/\/ true if the item is protected and can\u2019t be controlled<\/pre>\n
[\/vc_column_text][vc_column_text css=””]<\/p>\n
console.log<\/h2>\n
Use console.log()<\/strong> to write messages to the panel’s logging window.
\nThe local interface must be selected in the log view to see the messages.[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
console.log(\"This is a status out of the script\")<\/pre>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
console.log(itemValue) \r\nconsole.log(itemSelected) \r\nconsole.log(itemLight) \r\nconsole.log(itemProtected)<\/pre>\n
[\/vc_column_text][vc_message message_box_color=”success” icon_fontawesome=”fa fa-solid fa-hand-point-up” css=””]Enable the local interface in the logging window to view console.log<\/code> messages.[\/vc_message][vc_column_text css=””]<\/p>\n
Convert RGB HSL<\/h2>\n
Use the following functions to convert RGB to HSL and vice versa:<\/p>\n
[\/vc_column_text][vc_column_text css=”” el_class=”codebox”]<\/p>\n
\/\/ RGB to HSL\r\n\r\nlet hsl = rgb2hsl(red,green,blue)\r\nhue = hsl[\"h\"]\r\nsaturation = hsl[\"s\"]\r\nlightness = hsl[\"l\"]\r\n\r\n\/\/HSL to RGB<\/pre>\n
\n
let rgb = hsl2rgb(hue,saturation,lightness)\r\nred = rgb[\"r\"]\r\ngreen = rgb[\"g\"]\r\nblue = rgb[\"b\"]<\/pre>\n<\/div>\n
[\/vc_column_text][\/vc_column][\/vc_row]<\/p>\n<\/div>","protected":false},"excerpt":{"rendered":"
[vc_row el_class=”welcomebox” css=”.vc_custom_1707149624705{margin-bottom: 20px !important;padding-bottom: 5px !important;}”][vc_column][vc_row_inner][vc_column_inner width=”1\/2″][vc_column_text css=””] Scripts [\/vc_column_text][\/vc_column_inner][\/vc_row_inner][vc_column_text css=””]Bring your panel to the next level with the power of JavaScript![\/vc_column_text][\/vc_column][\/vc_row][vc_row css=”.vc_custom_1707045863978{background-color: rgba(15,0,0,0.3) !important;*background-color: rgb(15,0,0) !important;}” el_class=”.grayBox” el_id=”interfaces”][vc_column][vc_column_text css=””] With scripts in Commands and Events, you can run simple JavaScript code.You have access to all Swaps inside your script and can use them…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":1634,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-3292","page","type-page","status-publish","hentry","description-off"],"_links":{"self":[{"href":"https:\/\/devicejockey.de\/index.php?rest_route=\/wp\/v2\/pages\/3292","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devicejockey.de\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/devicejockey.de\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/devicejockey.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/devicejockey.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3292"}],"version-history":[{"count":52,"href":"https:\/\/devicejockey.de\/index.php?rest_route=\/wp\/v2\/pages\/3292\/revisions"}],"predecessor-version":[{"id":3516,"href":"https:\/\/devicejockey.de\/index.php?rest_route=\/wp\/v2\/pages\/3292\/revisions\/3516"}],"up":[{"embeddable":true,"href":"https:\/\/devicejockey.de\/index.php?rest_route=\/wp\/v2\/pages\/1634"}],"wp:attachment":[{"href":"https:\/\/devicejockey.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3292"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}