Sommaire
Envoyer des messages
Pour envoyer des messages et invoquer des méthodes (MessageCallbacks) d’autres packages (ou consommateurs, pages Web, apps mobile, etc… ), vous pouvez utiliser la méthode “sendMessage” :
|
1 |
constellation.sendMessage(scope, args, messageKey, data); |
C’est une fonction “variadic“ qui peut prendre plusieurs arguments qui seront utilisés pour formater le contenu (data) du message :
|
1 |
constellation.sendMessage(scope, args, messageKey, data, ...); |
Par exemple pour envoyer un message “DemoMessage” avec en contenu un objet contenant deux propriétés (c’est à dire invoquer le MessageCallback “DemoMessage” en passant en paramètre un objet à deux propriétés) au package “MyCsharpPackage“ :
|
1 |
constellation.sendMessage(Package, "MyCsharpPackage", "DemoMessage", "{ A: '%s', B: %d }", myStringVal, myIntVal); |
Autre exemple : envoyer un message “SignalReceive” au groupe “IR” (dans lequel plusieurs packages ou consommateurs peuvent s’inscrire) avec en paramètre une valeur de type ”long” formatée en hexadécimal :
|
1 2 |
unsigned long value = results.value; // the IR signal decoded constellation.sendMessage(Group, "IR", "SignalReceive", "%#x", value); |
Le scope
Le scope permet de définir les destinataires du message (plus d’information ici).
Dans la libraire Arduino/SP, l’argument Scope est une énumération définie de la façon suivante :
|
1 2 3 4 5 6 7 8 |
enum ScopeType : uint8_t { None = 0, Group = 1, Package = 2, Sentinel = 3, Other = 4, All = 5 }; |
L’argument “args” spécifie les arguments du scope, par exemple le ou les noms des packages, des sentinelles ou des groupes où envoyer le message. Pour cibler une instance d’un package vous spécifierez le nom de l’instance complet “SENTINEL/Package” (plus d’information ici).
Si vous avez plusieurs “args” vous devez les séparer par des virgules. Par exemple pour envoyer un message “HelloWorld” au groupe A et au groupe B :
|
1 |
constellation.sendMessage(Group, "A,B", "HelloWorld", "{}"); |
Le contenu (Data) du message
Dans la philosophie des MessageCallbacks, le contenu du message (Data) permet de stocker les arguments d’une fonction (MessageCallback) à invoquer.
Si vous invoquez un MC sans paramètre, vous devez spécifier un objet vide “{}” :
|
1 |
constellation.sendMessage(Package, "DemoPackage", "HelloWorld", "{}"); |
Si vous avez plusieurs paramètres à passer, vous formaterez vos arguments dans un tableau :
|
1 |
constellation.sendMessage(Package, "DemoPackage", "SayHello", "[ 'Sebastien', 'Warin' ]"); |
Vous pouvez également envoyer en tant qu’argument un objet complexe, par exemple :
|
1 |
constellation.sendMessage(Package, "DemoPackage", "SayHello", "{ 'FirstName':'Sebastien', 'LastName':'Warin' }"); |
Ou bien même un mixte, par exemple un MC prenant en paramètre un objet complexe et un entier :
|
1 |
constellation.sendMessage(Package, "DemoPackage", "SayHello", "[ { 'FirstName':'Sebastien', 'LastName':'Warin' }, 42 ]"); |
Ici le contenu du message est formaté en JSON via une chaine de caractère mais vous pouvez également passer un JsonObject à cette méthode :
|
1 2 3 4 5 6 |
const int BUFFER_SIZE = JSON_OBJECT_SIZE(2); StaticJsonBuffer<BUFFER_SIZE> jsonBuffer; JsonObject& data = jsonBuffer.createObject(); myStateObject["FirstName"] = "Sebastien"; myStateObject["LastName"] = "Warin"; constellation.sendMessage(Package, "DemoPackage", "SayHello", data); |
Notez aussi que la Console Constellation liste les MessageCallbacks déclarés par l’ensemble des packages de votre Constellation et vous génère le code pour chaque API.
Par exemple, si vous souhaitez invoquer le MessageCallback “PushNote” du package “PushBullet” qui vous permettra d’envoyer une notification sur un smartphone vous pouvez cliquez sur l’icone de génération de code :
Sélectionnez ensuite le langage “Arduino” pour avoir le modèle correspondant :
Ainsi pour envoyer une notification sur mon smartphone depuis un Arduino/ESP :
|
1 |
constellation.sendMessage(Package, "PushBullet", "PushNote", "[ 'Demo from Arduino', 'Ceci est une demo', 'Device', '' ]"); |
Bien entendu, n’importe quel package ou consommateur peut recevoir des messages. Vous pouvez donc invoquer des méthodes C#, Python, JS, etc.. depuis un Arduino/ESP.
Envoyer des messages avec réponse : les Sagas
Les Sagas permettent de lier des messages et donc de créer des couples de “requêtes / réponses”.
Avec la libraire Arduino/ESP, il est possible d’envoyer des messages dans une saga afin d’enregistrer un callback de traitement de la réponse.
Par exemple, le package “NetworkTools” expose entre autre un MessageCallback “Ping” permettant de pinger une machine. Si le MC est invoqué dans une saga, le package répondra dans la saga un message contenant le temps de réponse du ping.
De ce fait, si nous souhaitons invoquer cette méthode depuis notre Arduino et traiter la réponse, nous pouvons écrire :
|
1 2 3 4 |
const char* ip = "192.168.0.10"; constellation.sendMessageWithSaga([](JsonObject& json) { constellation.writeInfo("Ping response in %s ms", json["Data"].as<char *>()); }, Package, "NetworkTools", "Ping", "[ '%s' ]", ip); |
La signature de la méthode “sendMessageWithSaga” est la même que la méthode “sendMessage” présentée ci-dessus à la seule différence qu’elle prend comme 1er argument un callback vers une fonction traitant la réponse ici passée en tant que lambda.
Dans l’exemple ci-dessus, votre Arduino envoie donc un message “Ping” avec une adresse IP en paramètre au(x) package(s) “NetworkTools” en associant un n° de saga. Ce package exécutera le ping et vous retournera un message de réponse avec le résultat du ping. Cette réponse sera traitée par la fonction lambda qui dans l’exemple affichera dans les logs Constellation le résultat du ping.
Ainsi vos Arduino/ESP peuvent très facilement invoquer des méthodes (MessageCallback) avec ou sans retour des différents packages (virtuels ou non) ou consommateurs de votre Constellation; scripts Javascripts, Powershell, Bash, programmes .NET, Python, etc…
Démarrez la discussion sur le forum Constellation