Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
fr:calaos_tuto_liste_scripts_lua [2015/09/11 14:48]
eric64 		fr:calaos_tuto_liste_scripts_lua [2021/02/04 10:16] (current)
admin [Lexique]
Line 1: Line 1:
-====== Bibliothèque des script LUA des membres ======+====== Bibliothèque des scripts LUA des membres ======
  
  
  
  
-===== 1- Quelques explications : =====+===== Quelques explications : =====
 Les scripts sont utilisés dans CALAOS pour permettre de réaliser des actions plus complètes et gérer plus finement les éléments, ce qui n'est pas possible avec des règles "simples". Les scripts sont utilisés dans CALAOS pour permettre de réaliser des actions plus complètes et gérer plus finement les éléments, ce qui n'est pas possible avec des règles "simples".
  
Line 14: Line 14:
  
  
-**Définition du LUA :** (Rèférence : [[https://fr.wikipedia.org/wiki/Lua]])+\\ **__Définition du LUA :__** (Rèférence : [[https://fr.wikipedia.org/wiki/Lua]])
 <code> <code>
 Le Lua est un langage de script libre, réflexif et impératif. Le Lua est un langage de script libre, réflexif et impératif.
Line 25: Line 25:
 </code> </code>
  
-**Documentations sur le LUA à lire :** +\\ **__Documentations sur le LUA à lire :__** 
  
 Site officiel : [[http://www.lua.org/]] Site officiel : [[http://www.lua.org/]]
Line 33: Line 33:
 Autre site intéressant : [[http://www.luteus.biz/Download/LoriotPro_Doc/LUA/LUA_Training_FR/Introduction_Programmation.html]] Autre site intéressant : [[http://www.luteus.biz/Download/LoriotPro_Doc/LUA/LUA_Training_FR/Introduction_Programmation.html]]
  
-===== 2-Lexique =====+\\  
 +===== Lexique =====
  
  
-**Fonctions propres à CALAOS :**+**__Fonctions propres à CALAOS :__**
  
-**calaos:getInputValue("N° intput", str) :** Permet de sélectionner un numéro d'entrée et de lui attribuer une valeur. (Cette valeur doit être au préalable stockée dans str)+See source code https://github.com/calaos/calaos_base/blob/master/src/bin/calaos_server/LuaScript/ScriptBindings.cpp
  
-**calaos:getOutputValue("N° output", str) :** Permet de sélectionner un numéro de sortie et de lui attribuer une valeur. (Cette valeur doit être au préalable stockée dans str)+**str = calaos:getInputValue("id") :** Permet de récupérer la valeur d'une entrée et la stocker dans str. (str est facultatif et peut s'appeler autrement)
  
-**calaos:setOutputValue("id", "valeur") :** Permet+**str = calaos:getOutputValue("id") :** Permet de récupérer la valeur d'une sortie et la stocker dans str.
  
-**calaos:requestUrl("url") :** Permet+**calaos:setOutputValue("id", "valeur") :** Permet d'attribuer une valeur à une sortie.
  
-**calaos:requestUrl("url", "POST DATA") :**Permet+**calaos:requestUrl("url") :** Permet d'appeler une URL
  
 +**calaos:requestUrl("url", "POST DATA") :** Permet d'appler une URL avec des données en POST
  
 +==== Uniquement v3 ====
  
 +**calaos:getIOParam("id", "parametre") :** Permet de recuperer un parametre d'un IO (visible, enabled, ...)
  
 +**calaos:setIOParam("id", "parametre", valeur) :** Permet de d'attribuer une valeur a un parametre d'un IO (visible, enabled, ...)
  
-**Fonctions "classique" du LUA:**+**calaos:waitForIO("id") :** Bloque le script et attend que l'IO passé en parametre change. Cela permet d'attendre qu'un IO fasse un trigger dans le script en le bloquant. A partir de calaos v3, les scripts peuvent etre bloquant indéfiniment contrairement a la v2 ou un script ne peut tourner que 2s max. 
 + 
 +**calaos:getEnv("trigger_id") :** Permet de récupérer l'id du trigger qui a déclenché le script. 
 + 
 +**calaos:sendPushNotif("message", "camera_attachment_id_optional") :** Permet d'envoyer un message push sur mobile avec une capture de camera optionelle 
 + 
 +\\ **__Fonctions "classiques" du LUA:__** 
 + 
 +**print("xxxx") :** Sert à afficher un message dans les logs, principalement pour débuguer
  
 ** - - :** Permet d’ajouter un commentaire dans le script (en vert dans les scripts pour plus de lisibilité) ** - - :** Permet d’ajouter un commentaire dans le script (en vert dans les scripts pour plus de lisibilité)
  
-**str = :** Permet de stocker une valeur (str est un "POST DATA", on peut lui donner le nom qu'on veut)+**str = :** Permet de stocker une valeur (str est un exemple, on peut lui donner le nom qu'on veut)
  
 **("input_4") :** Numéro d’entrée défini dans Calaos. (Il est possible de connaître les Numéros de toutes les entrées via Calaos Installer.) **("input_4") :** Numéro d’entrée défini dans Calaos. (Il est possible de connaître les Numéros de toutes les entrées via Calaos Installer.)
Line 69: Line 82:
  
 **return true :** Met fin au script **return true :** Met fin au script
 +
 +\\
 + ===== Comment créer un script LUA dans CALAOS INSTALLER=====
 +\\ **En construction**
  
  
-===== 3-Liste des scripts LUA ===== +\\ ===== Liste des scripts LUA ===== 
-[[Liste_script|Liste des script]]+[[Liste_script|Liste des scripts]]