Arturia KeyLab Essential /MKII Display and LEDs with GPScript

Dome · April 26, 2025, 10:46am

This project is inspired by several posts shared in the community over the years, as well as a document that explains the SysEx messages used to control the display and LED feedback.

Using the central knob, you can navigate through the menu, which has the following structure:

SETLIST → RACKSPACE → SET BPM → TIME SIGNATURE NUM → TIME SIGNATURE DEN → TRANSPOSE

To enter the menu, press the knob button. To exit, press the knob button again.

The script uses OSC to send text messages to the display and to turn the PADs on/off
This technique also makes it possible to use Widgets directly to send messages to the keyboard
Messages are sent through the computer’s loopback address and the port configured in the OSC section

 // Syntax code  
 SendOSCMessage   { /LCD, "## WELCOME TO ##"," #### GIG #####"  } to IP : PORT // Send the message to the specified IP address and port number

To test the direct OSC message there is a panel in Global rackspace

Here the link to the Wiki for documentation and tips for installation

Sample project
KeyLab61_Daw.gig (350.2 KB)

It’s necessary to copy the GPSystemScript in the folder …\Scripts\Autoload

github.com/DomenicoPatella/GPScriptNotepad

GPScript/GPSystemScript.gpscript

main

//******************************************************
//
// GPSystem Script 
// 
//
//******************************************************/

//DEFINE GLOBAL VAR
var 
LCDRows : string[2]
CURR_PAGE: integer
SySx : SysexMessage

// DON'T MODIFY 
const
KEYLAB_LCD_HEAD  : String  = "F0 00 20 6B 7F 42 04 00 60 01 " 
KEYLAB_LCD_SEP   : String  = "00 02 "
KEYLAB_LCD_END   : String  = "00 F7"
KEYLAB_LED_HEAD  : String  = "F0 00 20 6B 7F 42 02 00 16 "
KEYLAB_LEDM_HEAD  : String  = "F0 00 20 6B 7F 42 02 00 10 "

This file has been truncated. show original

GigScript

github.com/DomenicoPatella/GPScriptNotepad

GPScript/Gig%20Script.gpscript

main

/* Include the GPSystemScript if defined in the AutoLoad subdirectory of your scripts folder
** Write Text to LCD
//Function KeylabLCD(rowStr1 : string ,rowStr2 :string) returns String for SysexMessage

** Split a string in two strings array of 16 char or with a separator % (if string >16 char last char will be '*'  
//Function SpiltStringArray(str : string) (internal)  

** Write Led PAD Color/Off 
//Function KeylabLED(i : integer, colour : integer ) returns String	for SysexMessage 
*/
Include "$system$"

/******************************************************
//
// Gig Script
//
// KeyLab Essential 61  Map  : DAW
//
******************************************************/

This file has been truncated. show original

GlobalScript

github.com/DomenicoPatella/GPScriptNotepad

GPScript/GLOBAL%20RACKSPACE%20Script.gpscript

main

Include "$system$"

/******************************************************
//
// Global Script
//
******************************************************/
var 
Arturia : MidiInBlock

const
TIMETRS : integer= 4000  // ms Transintion time to display song part 



Initialization
	var i : integer
	//SetWidgetLabel(txtLed1,RGB[0])
	//Init set Pad Led ON 
	For i=0;i<LEDCOUNT ; i=i+1 Do

This file has been truncated. show original

dhj · April 26, 2025, 11:03am

I’m missing something.

How are you sending OSC messages to the Arturia keyboard?

Dome · April 26, 2025, 11:11am

Yes sorry it is not explained well .
I use OSC to create an internal text message within GiG and then send a sysex message to Keylab
I liked having the ability to give the option to use a widget to send a text or drive an LED without writing code

dhj · April 26, 2025, 11:24am

Ah ok - that’s actually very cute.

Well done.

tripleB · April 26, 2025, 4:54pm

This look very, very good!

And much better documented than Scriptlet: Arturia KeyLab MkII LED control

Well done! Thanks for sharing!

It seems to be easier to use the LCD on the essential models, than on the standard mkII. I still did not figure out how to use the LCD when in USER mode

Dome · April 27, 2025, 5:55am

Thanks @tripleB I started from your great work , you deserve to be mentioned !
It seems to me that even in User mode the display works , I have to try again to be sure.
With the MKII version it does not work ? I would be curious to know if these scripts also work with that version