Sommaire
Vous pouvez connecter tout type d’objet ou système dans Constellation à partir du moment où vous disposez d’une connectivité IP pour réaliser des appels HTTP.
Introduction
Par exemple si vous disposez d’un Arduino il vous faudra un shield Ethernet ou Wifi bien que ces derniers ont été retirés du support Arduino.
Arduino propose en alternative des modèles déjà équipés d’une connectivité Ethernet et/ou Wifi comme le MKR1000, le Yun Shield ou le Wifi Shield 101.
En alternative vous avez les ESP8266 que j’ai pu vous présenter sur mon blog personnel.
Ce microcontrôleur est cadencé à 80Mhz par un processeur 32bits RISC avec 96K de RAM et une mémoire flash de 512Ko à 4Mo selon les modèles.
Il dispose d’une connectivité Wifi 802.11 b/g/n supportant le WEP, WPA/2/WPS et réseau ouvert et 16 GPIO dont le support du SPI, I²C, UART et un port ADC (pour les I/O analogiques).
Vous trouverez différents modèles sur internet, comme ceux produit par AI-Thinker mais il faudra réaliser vous même la carte de programmation comme je l’explique sur mon blog ou bien des modules “tout en un” comme ceux d’Adafruit ou Sparkfun disposant d’un port USB intégré pour une programmation facile :
Si vous débutez je vous recommande la Wemos D1 Mini qui intègre un ESP8266 avec 4M de mémoire Flash, 11 I/O digitales et 1 analogique (ADC) ainsi qu’une interface USB le tout pour moins de 5€ :
Pour bien comprendre les ESP8266, je vous recommande une nouvelle fois mon article Découverte des ESP8266 : le microcontrôleur connecté par Wifi pour 2€ au potentiel phénoménal avec Constellation
Le plus important étant que les ESP8266 peuvent être programmés comme les Arduino avec l’IDE Arduino.
Arduino/ESP8266 = package virtuel
Ce concept a déjà été abordé ici. En clair le micro-programme d’un Arduino ou d’un ESP est stocké dans la puce elle même et il n’y a pas de concept de “processus” sur ce genre de device. Il n’est donc pas possible d’avoir une véritable sentinelle qui tourne ce genre d’objet pour déployer et superviser des packages Constellation à la volée comme sur un système Windows ou Linux.
C’est pour cela qu’on parle de sentinelle et de package “virtuel” : on déclare bien dans la configuration de notre Constellation une sentinelle (par exemple nommée “Arduino” et associée à un credential) et contenant un package (par exemple nommé “TemperatureSensor”). Ce package peut être joint à des groupes et avoir des settings qui lui sont propres.
Dans le microprogramme téléversé sur votre Arduino/ESP vous allez vous connecter en spécifiant le nom de la sentinelle et du package virtuel (ici Arduino/TemperatureSensor) et la clé d’accès associée. Votre device sera alors connecté à Constellation comme étant le package “TemperatureSensor” sur la sentinelle “Arduino”. Comme n’importe quel package il pourra produire des logs, publier des StateObjects, récupérer ses settings, envoyer ou recevoir des messages ou encore consommer les StateObjects d’autres packages.
Techniquement parlant l’Arduino/ESP utilise l’API REST “Constellation”.
Installer la librairie Constellation dans l’IDE Arduino
Ouvrez le « Gestionnaire de bibliothèque » dans le menu « Croquis > Inclure une bibliothèque > Gérer les bibliothèques » :
Avec le moteur de recherche, recherchez le terme « ArduinoJson » :
Vous trouverez lors la bibliothèque « ArduinoJson » de Benoit Blanchon (dépendance de la librairie Constellation) ainsi que la librairie Constellation.
Pour ces deux bibliothèques, cliquez sur le bouton « Installer » (ou « Mise à jour » si la librairie est déjà installée).
Hello World, Hello Constellation
Commencez par créer un nouveau sketch et ajoutez la librairie Constellation :
|
1 |
#include <Constellation.h> |
Vous pouvez maintenant déclarer le client “Constellation” en l’initialisant avec l’adresse (IP ou DNS) de votre serveur Constellation, le port et les informations de connexion de Constellation, c’est à dire le nom de votre sentinelle et package ainsi que la clé d’accès que vous aurez déclarés sur votre serveur :
|
1 |
Constellation<WiFiClient> constellation("IP or DNS du serveur constellation", 8088, "MyVirtualSentinel", "MyVirtualPackage", "123456789"); |
Pour ajouter une sentinelle virtuelle cliquez sur le bouton “Add sentinel” sur la page “Sentinels” de la Console Constellation :
Puis ajoutons un package virtuel en cliquant sur le bouton contextuel de notre sentinelle “Deploy package” ou directement depuis la package “Packages” :
Déclarez ensuite le nom de votre package, ici “MyVirtualPackage” utilisant la même clé que celle définie au niveau de la sentinelle :
Vous remarquerez que dans la déclaration du client Constellation nous avons spécifié dans le template de la classe Constellation le type de notre client réseau, qui dans le cas d’un ESP8266 ou d’un Arduino MKR1000 est “WifiClient”.
N’oubliez pas d’ajouter les librairies de votre client réseau, quelques exemples :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
/* Arduino Wifi (ex: Wifi Shield) */ #include <SPI.h> #include <WiFi.h> /* Arduino Wifi101 (for WiFi Shield 101 and MKR1000 board) */ #include <SPI.h> #include <WiFi101.h> /* Arduino Ethernet */ #include <SPI.h> #include <Ethernet.h> /* ESP8266 Wifi */ #include <ESP8266WiFi.h> |
Au démarrage du programme, nous allons d’abord connecter votre client réseau sur le réseau. Dans le cas d’un ESP8266, on se connecte au réseau Wifi de cette façon :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
void setup(void) { Serial.begin(115200); // Connect to Wifi WiFi.begin("MY-SSID", "MY-WIFI_KEY"); while (WiFi.status() != WL_CONNECTED) { delay(500); Serial.print("."); } // For WiFi101, wait 10 seconds for connection! // delay(10000); Serial.println("WiFi connected. IP: "); Serial.println(WiFi.localIP()); } |
Une fois connecté au réseau, on peut utiliser les méthodes de la librairie Constellation.
Par exemple, produisons un log avec la méthode “WriteInfo” :
|
1 |
constellation.writeInfo("Hello Constellation"); |
Cette méthode gère nativement le formatage “à la printf”, par exemple :
|
1 |
constellation.writeInfo("Hello Constellation, I'm '%s !", constellation.getSentinelName()); |
Notez que vous pouvez produire de la même façon des messages de type “Info”, “Warning” ou “Error” :
|
1 2 3 |
constellation.writeInfo("This is an information"); constellation.writeWarn("This is a warning"); constellation.writeError("This is an error"); |
Bien entendu, comme n’importe quel package, les logs sont remontés en temps réel dans la Constellation ce qui permet à n’importe quel “contrôleur” de voir les logs de votre Arduino/ESP en temps réel.
Par exemple, en ouvrant la Console Constellation on pourra suivre votre Arduino/ESP en temps réel :
Accès aux settings
Tous les settings des packages de votre Constellation sont déclarés depuis le fichier de configuration de votre Constellation. Vous pouvez aussi utiliser la Console Constellation pour les administrer.
Dans votre code Arduino, vous devez utiliser la méthode “getSettings” pour récupérer un objet JSON contenant les settings (clé/valeur).
|
1 |
JsonObject& settings = constellation.getSettings(); |
Par exemple pour récupérer la valeur du setting “MonChiffre” déclarée sur le serveur à 42 :
|
1 2 |
JsonObject& settings = constellation.getSettings(); static int monChiffre= settings["MonChiffre"].as<int>() |
La variable “monChiffre” sera donc affectée à la valeur “42”. Dans l’exemple ci-dessus, la variable est statique pour pouvoir être utilisée n’importe où dans votre code.
Pour les chaines de caractères vous pouvez utiliser la classe “String” :
|
1 2 |
JsonObject& settings = constellation.getSettings(); static String strMaChaine = String(settings["MaChaine"].as<char *>()); |
Encore une fois la variable est statique pour pouvoir l’utiliser n’importe où dans votre code.
Si vous devez convertir votre chaîne de caractères en const char *, vous pouvez utiliser la fonction c_str() :
|
1 |
const char* maChaine = strMaChaine.c_str(); |
Vous pouvez également tester la présence d’un setting avec la méthode « containsKey » :
|
1 2 3 |
if(settings.containsKey("MySetting")) { // Do something with settings["MySetting"] } |
Par exemple vous pouvez gérer les valeurs par défaut. Imaginez un code où la valeur d’un timeout est de 5 secondes par défaut mais vous vous laissez la possibilité de surcharger cette variable depuis les settings Constellation :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// Default value int timeout = 5; // sec setup() { // ..... JsonObject& settings = constellation.getSettings(); if(settings.containsKey("Timeout")) { timeout = settings["Timeout"].as<int>(); } } void loop() { // DO something with 'timeout' } |
Si le setting « Timeout » est défini dans les settings de votre package sur Constellation, la variable « timeout » sera affectée à votre valeur, autrement, si le setting n’existe pas, la valeur de cette variable sera de 5.
Publier des StateObjects
Pour produire et publier un StateObject dans votre Constellation vous devez invoquer la méthode “pushStateObject” :
|
1 |
constellation.pushStateObject(name, value); |
Vous pouvez aussi passer le “type” de votre StateObject :
|
1 |
constellation.pushStateObject(name, value, type); |
Notez que pour les types simples (int,bool, long, float et double) le type est spécifié implicitement.
Par exemple, pour publier un StateObject dont la valeur est un chiffre :
|
1 |
constellation.pushStateObject("Temperature", 21); |
Vous pouvez aussi publier des StateObject avec un objet complexe en utilisant la fonction “stringFormat” pour formater votre valeur en JSON.
Par exemple pour publier un StateObject nommé “Lux” étant un objet contenant 3 propriétés :
|
1 |
constellation.pushStateObject("Lux", stringFormat("{ 'Lux':%d, 'Broadband':%d, 'IR':%d }", lux, full, ir)); |
Vous pouvez également faire la même chose en construisant un “JsonObject” :
|
1 2 3 4 5 6 7 |
StaticJsonBuffer<200> jsonBuffer; JsonObject& root = jsonBuffer.createObject(); root["Lux"] = lux; root["Broadband"] = full; root["IR"] = ir; constellation.pushStateObject("Lux", &root); |
Une fois vos StateObjects publiés, ils sont accessibles en temps réel aux autres packages et consommateurs de votre Constellation. Vous pouvez également utiliser le “StateObject Explorer” de la Console Constellation pour explorer tous les StateObjects de votre Constellation :
Next steps
- Publier des StateObjects
- Envoyer des messages
- Recevoir des messages
- Consommer des StateObjects
- Connectez vos ESP8266 à Constellation en Lua avec NodeMCU
Démarrez la discussion sur le forum Constellation