Comment bien débuter avec Node-Red.

Ce tutoriel est, en partie, un copier coller depuis un autre forum avec l’accord de son auteur SNoof (Merci à lui), mais nous en avons profiter pour ajouter d’autre choses.

Introduction.

Node-Red est une autre manière beaucoup plus visuelle de créer des automatisations, scripts et scènes pour Home Assistant. Il vous permet des automatisations plus avancées que les automatisation en YAML

Nous allons, dans cet article, tenter de couvrir un peu le sujet, surtout pour les débutants.

S’il y a des manques, des questions, des points que vous souhaitez voir abordés en plus, n’hésitez pas ! Si nous pouvons répondre et apporter un plus nous le ferons !

Nous allons voir dans ce topic :

  • Un peu de vocabulaire pour comprendre Node-Red
  • Revue la palette Home Assistant
  • Quelques nœuds sympas à utiliser
  • Quelques exemples qui permettent d’expliquer tout ça !
  • Comment installer une palette supplémentaire.

Ready !

Mise à jour : 15/07/2020 – Temps de lecture / alisation : 20 / 10 min – Difficulté : Faible.

To do :

  • RAS

Prérequis.

Matériels nécessaires.

  • Rien de spécifique.

Matériels utilisés.

  • Rien de spécifique.

Un peu de vocabulaire.

  • Un flow : le flow est une feuille (un peu à la manière Excel) sur laquelle vous allez créer des nœuds qui seront reliés par des liens.
    On peut en créer plusieurs qui peuvent, ou pas, communiquer entre eux.
  • Une palette : C’est un ensemble de nœuds.
  • Un nœud : C’est l’élément actif. Il reçoit/[modifie]/envoie des messages.
    Il a 0/1/des entrées et 0/1/des sorties en fonction de ses capacités ou options.
  • Un lien : c’est ce qui fait communiquer 2 nœuds. Un lien doit TOUJOURS être tracé entre l’entrée (input) d’un nœud et la sortie (output) d’un autre nœud.
  • Le message : c’est l’information qui passe de nœuds en nœuds via les liens. Ce message est un objet json qu’on peut manipuler au bon gré des nœuds utilisés sur son chemin.
    Sachant que le message est un objet json, le message pour contenir beaucoup de choses. En associant des clés à des valeurs. Pour accéder aux valeurs stockées il faudra en connaître le « path », le chemin en Français.

Exemple :

{"msg":
  {"payload":
    {
      "clé1":"Toto",
      "clé2":"Titi"
    },
  "clé3":"Tutu"
  }
}

Le chemin pour accéder à la valeur de la clé1 (soit Toto) sera msg.payload.clé1
De même pour avoir la valeur de la clé2 : msg.payload.clé2
Pour la clé3 : msg.clé3
Je vous invite fortement à lire un peu sur le json pour vous faciliter la tâche avec Node-Red !
Un peu de lecture pour comprendre le json : https://la-cascade.io/json-pour-les-debutants/ 1

Déjà avec ça on va pouvoir avancer pas mal.

Revue de la palette Home Assistant :

  • Events :all : Ce nœud permet d’écouter les événements home assistant comme le changement d’état d’un entité, une action de notification retournée, le démarrage ou l’arrêt de Home Assistant… Ce nœud c’est celui qui peut écouter absolument tout de votre instance. Mais il n’est pas très filtrable donc assez gourmand en ressources vu qu’il voit beaucoup de choses passer !
  • Events: state : Un peu comme le nœud précédent mais celui ci n’écoute que les events de type state_change. Donc il ne verra passer que les changements d’états de vos entités.
  • Trigger: state : Une version avancée du nœud Events: state
  • call service : Ce nœud permet d’appeler un service Home Assistant (notify, light.turn_on…)
  • fire event : Ce nœud va permettre d’envoyer un event sur le bus d’events de Home Assistant
  • Current state : Avec ce nœud vous allez pouvoir interroger le statut courant d’une entité.
  • get entities : Permet de rechercher des entités selon plusieurs critères
  • get history : Pour aller rechercher le statut d’une entité dans l’historique de la database de Home Assistant. C’est la machine à remonter le temps !
  • get template : Si vous vous servez du moteur de templating de Home Assistant, avec ce nœud vous pourrez faire du templating depuis Node-Red !
  • wait until : Comme son nom l’indique, quand ce nœud reçoit un message, il va attendre que l’entité définie atteigne le statut défini avant de laisser passer le message !
  • API : Pour faire appel à l’API de Home Assistant

Quelques nœuds complémentaires importants :

Par défaut l’addon Node-Red comprends la palette Home Assistant et tous les nœuds originaux de Node-Red. Mais il y a aussi quelques autres ajouts. Je vais lister les quelques autres nœuds importants (liste non exhaustive et susceptible d’évoluer en fonction de mes usages/de vos questions et remarques !)

  • inject : Un des nœuds fondamentaux, permet d’envoyer un message sur un clic dans l’interface Node-Red ou à intervalle régulier.
  • debug : Le nœud qui sert tout le temps, permet de visualiser le message dans la console Node-Red. Quand on veut expérimenter/débugger
  • switch : 1 entrée et plein de sorties ce qui permet d’orienter le message vers un branche ou une autre en fonction du contenu du message
  • change : permet de manipuler le message
  • function : permet de manipuler le message avec du javascript
  • stop timer : pour temporiser le passage du message
  • big timer : le nœud ultime pour la programmation d’envoi de messages en fonction d’événements temporels (date/heure/soleil…). Très complet !
  • time range : 1 entrée et 2 sorties, on est dans l’intervalle de temps définie alors le message sort sur la sortie 1 sinon sur la sortie 2 ! Pratique et simple !
  • limit : Pour éviter de laisser passer plein de messages, ce nœud limite le nombre de messages qui passent durant un laps de temps.
  • MQTT in/out : Ces nœuds permettent de se connecter à un broker MQTT et de souscrire à un topic pour y envoyer ou en recevoir des messages.

La mise en pratique par l’exemple.

Vous êtes toujours en vie (ou vous n’avez rien lu de ce qui est au dessus) ?
On va faire un peu de pratique avec pour commencer un exemple tout simple qui permet de poser les bases !

Exemple 1 :

  • Ouvrez l’interface de Node-Red
  • trouvez le nœud inject dans le menu de gauche, glissez le sur la feuille de flow et déposez le ici.
  • trouvez le nœud debug et posez le à droite du nœud inject précédemment déposé (pas trop collé !)
  • Puis d’un coup de souris tracez un lien entre la sortie (à droite) du nœud inject à l’entrée du nœud debug
  • En haut à droite, cliquez sur Deploy
  • Bim ! Votre 1er flow ! (bon c’est de la merde hein).
  • Cliquez sur le petit carré du nœud inject puis en haut à droite cliquez sur le petit icône d’insecte (juste en dessous de deploy)
    Vous avez là le message que le nœud inject à envoyé à travers le lien au nœud debug . C’est quoi ce truc ? Un gros nombre… Le nœud inject par défaut envoie le timestamp et votre nœud debug vous le restitue tout simplement.
    Si on se penche un peu plus sur la fenêtre de debug, on peut voir 2 petits boutons à droite du message. Ils sont pratiques ! Le premier copie le « path » (voir le paragraphe vocabulaire), le second copie la valeur affichée.
Débuter avec Node-Red Flow 1
Débuter avec Node-Red Flow 1
Débuter avec Node-Red Flow 1 Debug
Débuter avec Node-Red Flow 1 Debug

Exemple 2 : Avec le nœud current state.

  • Déposez un nœud inject , un nœud current state puis un nœud debug et reliez les.
Débuter avec Node-Red Flow 2
Débuter avec Node-Red Flow 2
  • Double clic sur le nœud current state pour éditer ses propriétés (s’ouvre à droite de l’écran)
  • Dans Entity ID prenez par exemple un capteur de température de votre Home Assistant (commencez par taper « sensor. » et il y a une autocomplétion !!!)
  • Cliquer sur Done puis Deploy.
Débuter avec Node-Red Flow 2 Entity
Débuter avec Node-Red Flow 2 Entity

Débuter avec Node-Red Flow 2 Fini
Débuter avec Node-Red Flow 2 Fini
  • Clic sur le carré du nœud inject
  • Dans votre fenêtre de debug vous aurez le state remonté par votre capteur.

Débuter avec Node-Red Flow 2 Résultat
Débuter avec Node-Red Flow 2 Résultat
  • Double clic sur le nœud debug et dans Output cliquez sur « msg. » et choisissez « complete msg object ».
  • Deploy puis clic sur le carré du nœud inject
  • Cette fois le debug sera bien plus complet avec toutes les infos que le nœud current state est capable d’aller chercher.
    Passez en revue toutes ces infos, regardez les paths. Ça peut vous donner des idées de ce qui est faisable !
Débuter avec Node-Red Flow 2 Debug
Débuter avec Node-Red Flow 2 Debug
Débuter avec Node-Red Flow 2 Debug résultat
Débuter avec Node-Red Flow 2 Debug résultat

Bon deux exemples simples. On va parler un peu de l’objet « msg ». Le message qui passe et se modifie entre les nœuds. D’une façon générale, l’information importante d’un message est souvent contenue dans le path msg.payload mais parfois on veut aller chercher des infos secondaires elles sont souvent ailleurs dans le message. C’est pour ça que le nœud debug est utile et vous permet de visualiser où se trouvent ces infos. Utilisez le sans modération !
D’ailleurs, une sortie de nœud peut être reliée à plusieurs autres nœuds. Donc vous pouvez dans un flow intercaler des nœuds debug à plusieurs endroits pour voir l’évolution du message ! Quand vous passez le curseur de la souris sur les messages qui sont dans la fenêtre de debug le nœud qui à créé cette entrée dans le debug log est entouré par des pointillés rouges !

Exemple 3 : Le nœud call service (exemple valable si vous avez des lumières connectées !)

  • Déposez un nœud inject et un nœud call service et reliez les
Débuter avec Node-Red Flow 3
Débuter avec Node-Red Flow 3
  • Dans les options du noeud call service
    • dans la case domain sélectionnez light
    • Dans la case service sélectionnez toggle
    • Dans la case entity ID sélectionnez une de vos lampes connectées
Débuter avec Node-Red Flow 3 Call Service
Débuter avec Node-Red Flow 3 Call Service
  • Validez le nœud et clic sur Deploy
  • Cliquez sur le carré du nœud inject et magie votre lampe s’allume si elle était éteinte et inversement au second clic sur le nœud inject.
Débuter avec Node-Red Flow 3
Débuter avec Node-Red Flow 3

Plus compliqué.

Imaginons que l’entity ID que vous avez dans le nœud call service est « petite_lampe ».

  • Éditez le nœud inject. En face de Payload sélectionnez JSON et entrez
{"domain": "light", "service": "toggle", "data": {"entity_id": "petite_lampe"}}
  • (pensez à remplacer « petite_lampe » par la bonne entité chez vous !)
    Validez avec Done
Débuter qvec Node-Red Flow 3 JSON
Débuter avec Node-Red Flow 3 JSON
  • Éditez le nœud call service et effacez le contenu des cases domain et service puis entrez dans entity ID.
{{payload.domain}}.{{payload.service}}.{{payload.data}}

Valider avec Done puis Deploy.

Débuter avec Node-Red Flow 3 call service
Débuter avec Node-Red Flow 3 call service

Cliquez sur le carré du nœud inject Et boom ! ça fonctionne alors que le nœud call service est à moitié vidé de sa config !

Qu’est ce qu’on a fait ? 2 choses :

  • Une config « dynamique » du nœud call service :
    Les propriétés « domain » et « service » définies dans le nœud inject sont automatiquement lues par le nœud call service et intégrées à sa configuration.
  • Du templating : La propriété « entity ID » elle à été récupérée par {{payload.domain}}.{{payload.entity}} qui est en fait une sorte de variable qui est lue venant du message entrant.

Du coup vous comprenez que pour un seul nœud call service vous pouvez lui faire faire un nombre d’actions différentes assez conséquent, en fonction du message qui entrera dedans !

Pour la config dynamique je vous conseille de lire la doc qui s’affiche à droite dans la fenêtre « i » (à côté du débug) quand vous sélectionnez un nœud. C’est la partie « inputs » qui en parle.

Bon on à joué avec du inject mais c’est pas comme ça qu’on automatise.

Exemple 4 (plus concret) : Allumer la lumière quand j’arrive à la maison et l’éteindre quand je pars (aucune condition).

NOTA : Cet exemple admet que vous ayez un device tracker, une zone home définie et une lumière connectée, pour l’exemple nous les appelleront device_tracker.moi et light.lampe => pensez à remplacer avec des valeurs correctes pour votre setup !

  • Déposez un nœud event: state et deux nœuds call service sans les relier.
Débuter avec Node-Red Flow 4
Débuter avec Node-Red Flow 4

Configurez le nœud event: state comme suit :

  • entity ID : device_tracker.moi (sur l’image person.mcfly)
  • if state is home.

Validez avec Done.

Débuter avec Node-Red Flow 4 Current State
Débuter avec Node-Red Flow 4 Current State
  • Configurez le premier nœud call service comme suit :
  • name : turn on
  • domain : light
  • service : turn_on
  • entity ID : light.lampe

Puis le deuxième avec le service turn_off.

Débuter avec Node-Red Flow 4 call service
Débuter avec Node-Red Flow 4 call service

Reliez les nœuds en « Y » la sortie du haut du nœud event: state vers le nœud call service qui a le service turn_on et la sortie du bas vers le nœud qui a turn_off.

Le nœud aura donc 2 sorties, celle du haut si la condition « state is home » est vraie, l’autre si la condition est fausse.

Cliquer sur Deploy.

On est bon ! Quand le device_tracker va passer à l’état home alors la lumière va s’allumer avec le service call light.turn_on et quand il passera à away ou not_home (ou autre) alors la lumière va s’éteindre !

NOTA : pour faire le test, allez changer votre état dans Outils de développement puis état. Rechercher votre state puis forcer la valeur home ou not_home par exemple.

outils de développement
outils de développement

Bon c’est mignon mais allumer la lumière quand il fait jour c’est naze ! On va filtrer selon le soleil, avec l’aide du nœud time range !

Ajoutez un nœud time range et configurez le comme suit :

  • name : nuit
  • Latitude : soit il est pré-rempli si tout est OK, soit vous mettez ici la Latitude de votre domicile
  • Longitude : pareil que pour la Latitude !
  • Start time : sunset
  • End time : sunrise

Validez avec Done.

Supprimez le lien entre le nœud event: state et le service call turn on . (suffit de cliquer dessus et faire Suppr sur son clavier !)

Reliez la sortie du haut du event: state au nœud time range appelé nuit et la sortie du haut de ce nœud nuit à l’entrée du nœud service call turn on.
(la sortie du bas du nœud time range laisse passer le message en dehors de la période configurée => En gros le jour quoi !)

Débuter avec NodeRed
Débuter avec NodeRed
  • Deploy.

Et voilà, si vous rentrez la nuit la lumière va s’allumer. Elle ne s’allumera pas la journée. Par contre si vous quittez votre domicile elle s’éteindra toujours automatiquement, que ce soit le jour, où la nuit !

Comment ajouter une palette supplémentaire.

Ajouter des palettes vous permet d’augmenter le nombre d’interaction et d’intégration possible dans vos automatisations via Node-Red, c’est un peu comme “ajouter des fonctions” à votre Node-Red.

Pour cela il suffit de cliquer sur le burger en haut à droit puis sur settings. Ensuite cliquer sur l’onglet Palette et Install. Dans filter nodes rentrer la palette a ajouter.

Node-red setting
Node-red setting
Node-Red Installation Palettes
Node-Red Installation Palettes

Dans notre cas node-red-contrib-telegrambot-home. Une fois trouvé cliquer sur Install.

Node-Red Palette telegram bot home
Node-Red Palette telegram bot home
Palette Telegram Bot Home Install
Palette Telegram Bot Home Install

NOTA : Si vous souhaitez des informations sur le nœud alors cliquer sur Open node Information.

Une fois installé vous avez dans la liste des nœuds, tous les nouveau nœuds Telegram.

Nœuds Telegram
Nœuds Telegram

Conclusion.

Cet article sur le fonctionnement de Node-Red pour un débutant et un très bon article de @SNoof, qui nous a autorisé à le copier coller sur notre site. Nous le remercions pour ce beau travail est espérons qu’il y en aura d’autres.

Nous espérons que cet article vous aidera a mieux comprendre Node-Red qui facilite grandement la mise en place des automatisations depuis Home Assistant. Vos automatisations seront beaucoup plus visuelles et surtout moins sujettes à des problèmes d’indentation.


Vous souhaitez signaler un erreur, partager votre configuration ou ajouter un matériel fonctionnant ? Cliquez sur les boutons ci-dessous.


Trucs & astuces.

Mise à jour : (détails)

15/07/2020 :

  • Ajout des images pour les flow exemple. (McFly)
  • Ajout de la procédure pour installer un palette de nœuds supplémentaire.

10/07/2020 :

  • Création de l’article

Sources.

  • RAS

Laisser un commentaire

Débuter avec NodeRed
Articles Node-Red