Module Scripts

Les scripts de module vous permettent d'ajouter une gestion plus complexe et plus spécifique des valeurs, d'aider à l'analyse des données provenant de flux réseau ou série qui suivent une API spécifique.

C'est également la façon de créer des Modules personnalisés, où vous pouvez définir vos propres valeurs et paramètres, et faire exécuter la logique principale par des scripts.

Fonctions communes des modules

Tous les scripts fonctionnant à l'intérieur d'un module auront un ensemble commun de fonctions qui pourront être ajoutées au script. Ces fonctions ne sont pas nécessaires pour exécuter le script.

Méthode	Description	Exemple
function moduleParameterChanged(param)	Cette fonction sera appelée chaque fois qu'un paramètre de ce module aura changé, c'est-à-dire un paramètre ou un déclencheur à l'intérieur du panneau "Parameters" de ce module.	function moduleParameterChanged(param){ script.log("Param changed : "+param.name) ; } ``
function moduleValueChanged(param)	Cette fonction sera appelée à chaque fois qu'une valeur de ce module aura changé, c'est-à-dire un paramètre ou un déclencheur à l'intérieur du panneau "Values" de ce module.	function moduleValueChanged(value) { if(value.isParameter()) { script.log("Valeur du module changée : "+value.name+") > "+value.get()) ; }else { script.log("Valeur du module déclenchée : "+value.name) ; } }

Fonctions spécifiques aux modules

Certains modules ont des rappels de fonctions spécifiques qui sont utiles si vous souhaitez personnaliser l'analyse des données reçues de ce module.

OSC

Méthode

Description

Exemple

oscEvent(address, args)

Cette fonction sera appelée à chaque fois qu'un message du CSP sera reçu. adresse est l'adresse du message du CSP args est un tableau contenant tous les arguments de l'OSC Message

fonction oscEvent(adresse, args) { script.log("OSC Message reçu "+adresse+" ;, "+args.length+" ; arguments" ;); }

MIDI

Méthode

Description

Exemple

noteOnEvent (canal, hauteur, vitesse)

Cette fonction sera appelée à chaque fois qu'un événement noteOn sera reçu. Les arguments sont respectivement le canal, le pas et la vitesse de cette event.

function noteOnEvent(channel, pitch, velocity) { script.log("Note on received "+channel+" ;, "+pitch+" ;, "+velocity); }

noteOffEvent (canal, hauteur, vitesse)

Cette fonction sera appelée à chaque fois qu'un événement noteOff sera reçu. Les arguments sont respectivement le canal, le pas et la vitesse de cette event.

function noteOffEvent(channel, pitch, velocity) { script.log("Note off received "+channel+" ;, "+pitch+" ;, "+velocity); }

ccEvent (canal, nombre, valeur)

Cette fonction sera appelée à chaque fois qu'un événement noteOff sera reçu. Les arguments sont respectivement le canal, le nombre et la valeur de cet événement.

fonction ccEvent(channel, number, value) { script.log("ControlChange reçu "+channel+" ;, "+number+" ;, "+value); }

sysExEvent(data)

Cette fonction sera appelée à chaque fois qu'un événement sysEx sera reçu. L'argument est un tableau d'octets contenant les données sysEx.

fonction sysExEvent(data) { script.log("Sysex Message reçu, "+data.length+" ; bytes :" ;); for(var i=0 ; i < ; data.length ; i++) { script.log(" ; > ; "+data[i]); } }

channelPressureEvent (channel, value)

Cette fonction sera appelée à chaque fois qu'un événement ChannelPressure sera reçu. Les arguments sont respectivement le canal et la valeur de cet événement.

fonction channelPressureEvent(channel, value) { script.log("Channel Pressure received "+channel+" ;, "+value); }

afterTouchEvent (canal, note, valeur)

Cette fonction sera appelée à chaque fois qu'un événement afterTouch sera reçu. Les arguments sont respectivement le canal, la note et la valeur de cette event.

fonction afterTouchEvent(channel, note, value) { script.log("After Touch received "+channel+" ;, "+note+" ;, "+value); }

Serial/UDP/TCP

Méthode

Description

Exemple

dataReceived(données)

Cette fonction sera appelée à chaque fois que des données auront été reçues. Si le protocole du Module's est réglé sur Lines, alors l'argument data sera une chaîne contenant la ligne, sans la terminaison \n. Sinon, les données seront un tableau d'octets contenant les data.

fonction dataReceived(data) { script.log("Données reçues : "+data); }

Websocket

Méthode	Description	Exemple
wsDataReceived(data)	Cette fonction sera appelée à chaque fois que des données binaires auront été reçues.	fonction wsDataReceived(data) { script.log("Données reçues : "+data.length); }
wsMessageReceived(message)	Cette fonction sera appelée à chaque fois qu'un message aura été reçu.	fonction wsMessageReceived(message) { script.log("Message reçu : "+message); }

HTTP

Méthode

Description

Exemple

dataEvent(data, requestURL)

Cette fonction sera appelée chaque fois que le module aura reçu une réponse de une demande. data est le contenu de la réponse demandeURL est l'url de la demande initiale.

fonction dataEvent(data, requestURL) { script.log("Données reçues, URL de requête :"+requestURL+"\nContenu :\n" ; +data); }style="text-align:left">fonction dataEvent(data, requestURL) { script. log("Données reçues, URL de demande :"+requestURL+"\nContenu :\n" ; +data); }

System

Method	Description	Example
processDataReceived(data, originCommand)	Cette fonction est appelée après un appel à launchProcess() et que blocking est à false. data contient la sortie du process originCommand contient la commande qui a déclenché cette sortie	function processDataReceived(data, command) { script.log("Data received",data,command); }

Méthodes spécifiques au module (l'objet local)

Certains modules ont des méthodes spécifiques qui sont utiles si vous voulez avoir des comportements spécifiques ou envoyer des données complexes ou automatisées. Ces méthodes font partie de l'objet Javascript local, en fonction du module dans lequel il s'exécute.

OSC

Méthode	Description	Exemple
send(address, arg1, arg2, arg3, ...)	Envoie un message OSC à toutes les sorties activées du module. address est l'adresse du message	local.send("myAddress", 1, .5f, "cool");
sendTo(ip, port, address, arg1, arg2, ...)	Même fonctionnement que send, mais envoie le message à une adresse ip et un port spécifique, sans tenir compte des sorties du module.	local.sendTo("192.168.0.30", 9000, "myAddress", 1, .5f);
match(address, pattern)	Vérifie si l'adresse address correspond au schéma pattern, conformément à la spécification OSC. Les astérisques, etc sont reconnus.	if (local.match(address, "/testPattern")) ...
register(pattern, callbackFunc)	Enregistre une fonction du script à appeler quand un message correspondant à pattern est reçu. callbackFunc est le nom de la fonction à appeler. [Note] Si le module contient plusieurs scripts, ce nom de fonction est enregistré pour tous les scripts.	function init() { local.register("/testPattern", "testPatternCallback"); } function testPatternCallback(address, args) { script.log("Received message "+address); }

MIDI

Méthode	Description	Exemple
sendNoteOn(channel, pitch, velocity)	Cela enverra un événement Note On sur le périphérique MIDI de sortie du module.	local.sendNoteOn (1, 12, 127);
sendNoteOff(channel, pitch)	Cela enverra un événement Note Off sur le périphérique MIDI de sortie du module.	local.sendNoteOff (1, 12);
sendCC(channel, pitch, velocity)	Cela enverra un événement Control Change sur le périphérique MIDI de sortie du module.	local.sendCC (3, 20, 65);
sendSysEx(byte1, byte2, byte3, ...)	Cela enverra un message SysEx sur le périphérique MIDI de sortie du module. Vous pouvez ajouter autant d'arguments que vous le souhaitez dans le message SysEx.	local.sendSysex (10, 15,20,20,0);
sendPitchWheel(channel, value)	Cela enverra un événement Pitch Wheel sur le périphérique MIDI de sortie du module.	local.sendPitchWheel (3, 2000);
sendChannelPressure(channel, value)	Cela enverra un événement Channel Pressure sur le périphérique MIDI de sortie du module.	local.sendChannelPressure (1, 67);
sendAfterTouch(channel, note, value)	Cela enverra un événement After Touch sur le périphérique MIDI de sortie du module.	local.sendAfterTouch (3, 20, 65);

DMX

Méthode	Description	Exemple
send(startChannel, value1, value2, ..., valueN)	Ceci enverra des valeurs DMX en démarrant par le canal DMX spécifié. Vous pouvez ajouter autant de valeurs que nécessaire, et même mélanger des tableaux de valeurs et des valeurs simples. Les valeurs vont de 0 à 255.	local.send(32, 255);

Serial/UDP/TCP/Websocket

Méthode	Description	Exemple
send(message)	Cela enverra la chaîne passée en caractères ASCII.	local.send("Ceci est mon message");
sendBytes(byte1, byte2, [bytes], ...)	Cela enverra tous les bytes passés tels quels. Les octets peuvent être regroupés dans des tableaux ou simplement disposés un par un, ou un mélange de tableaux et d'octets.	local.sendBytes(30,210, [255,0,0], 5);
sendTo(ip, port, message)	[UDP Only] Même chose que la méthode send, mais enverra vers un ip et un port spécifiques, en ignorant la sortie du module.	local.sendTo("192.168.1.255", 8888, "This is my message");
sendBytesTo(ip, port, byte1, byte2, [bytes], ...)	[UDP Only] Identique à la méthode sendBytes, mais enverra vers un ip et un port spécifiques, en ignorant la sortie du module.	local.sendBytesTo("192.168.1.255", 8888, 30,210, [255,0,0], 5);

HTTP

Méthode	Description	Exemple
sendGET(url)	Cela enverra une demande HTTP GET. Vous pouvez ajouter des paramètres à la fin de l'argument url, comme pour toute URL GET.	local.sendGET( "https://httpbin.org/anything?myValue1=1&myValue2=super");
sendPOST(url, param1, value1, param2, value2, ...)	Cela enverra une requête HTTP POST. Après avoir spécifié le url, vous pouvez ajouter une paire de valeurs qui sont respectivement le nom du paramètre et sa valeur.	local.sendPOST( "https://httpbin.org/anything", "myValue1", 1, "myValue2", 2);
sendPUT(url, param1, value1, param2, value2, ...)	Cela enverra une requête HTTP PUT. Après avoir spécifié le url, vous pouvez ajouter une paire de valeurs qui sont respectivement le nom du paramètre et sa valeur.	local.sendPUT( "https://httpbin.org/anything", "myValue1", 1, "myValue2", 2);
sendPATCH(url, param1, value1, param2, value2, ...)	Cela enverra une requête HTTP DELETE. Après avoir spécifié le url, vous pouvez ajouter une paire de valeurs qui sont respectivement le nom du paramètre et sa valeur.	local.sendPATCH( "https://httpbin.org/anything", "myValue1", 1, "myValue2", 2);
sendDELETE(url, param1, value1, param2, value2, ...)	Cela enverra une requête HTTP DELETE. Après avoir spécifié le url, vous pouvez ajouter une paire de valeurs qui sont respectivement le nom du paramètre et sa valeur.	local.sendDELETE( "https://httpbin.org/anything", "myValue1", 1, "myValue2", 2);

Object arguments

You can pass an object containing the parameters to send the request. All properties of the "params" object are optional. When adding all, this looks like this :

var params = {};
params.dataType = "json";
params.extraHeaders = "Content-Type: application/json";
params.arguments = ["myValue1",1,"myValue2",2];

var payload = {}; //the payload can be either a simple string or an object that will be automatically stringified
payload.super = "cool";
payload.number = 3.2;
params.payload = payload;

local.sendGET("anything", params); //the address field will be appended to the module's base address
local.sendPOST("anything", params);
local.sendPUT("anything", params);
local.sendPATCH("anything", params);
local.sendDELETE("anything", params);

System

Méthode	Description	Exemple
launchApp(appPath, arguments)	Lance une application au chemin fourni avec les arguments fournis	local.launchApp("myApp.exe", "-p myOption");
launchCommand(command, silentMode)	Lance une commande	local.launchCommand("myApp.exe", true);
launchProcess(command, blocking)	Lance un process et retourne la sortie. Si blocking est false, la sortie sera envoyée dans processDataReceived(data) Sinon, le programme sera bloqué le temps du process, et le contenu sera directement renvoyé.	var result = local.launchCommand("myApp.exe", true);
getRunningProcesses()	Liste les process en cours	var result = local.getRunningProcesses();
isProcessRunning(process)	Check if un process est en cours	var isRunning = local.isProcessRunning("MyApp.exe"