Skip to content

Teeflo/plugin-n8n

Repository files navigation

Plugin n8n Connect pour Jeedom

Version Jeedom License

📄 Description

Ce plugin Jeedom permet de piloter et de superviser vos workflows n8n directement depuis votre interface domotique Jeedom. Il offre une intégration simple et efficace pour lancer des workflows, les activer/désactiver, et vérifier leur état.

✨ Fonctionnalités principales

  • Configuration d'instance n8n : Connectez facilement votre Jeedom à votre instance n8n via son URL et une clé API.
  • Gestion des workflows : Créez des équipements Jeedom pour chaque workflow n8n que vous souhaitez contrôler.
  • Commandes d'action : Activez/Désactivez et lancez (via Webhook) vos workflows n8n.
  • Commande d'information : Obtenez le statut (actif/inactif) de votre workflow n8n.
  • Notifications d'erreur de workflow : Recevez des notifications dans Jeedom lorsqu'un workflow n8n échoue.
  • Sélection simplifiée : Choisissez vos workflows n8n via une liste déroulante ou saisissez manuellement leur ID.
  • Journalisation détaillée : Des logs précis pour faciliter le diagnostic en cas de problème.

🚀 Installation

L'installation du plugin n8n Connect est simple et suit la procédure standard des plugins Jeedom :

  1. Téléchargement : Depuis l'interface Jeedom, allez dans Plugins > Gestion des plugins > Market. Recherchez "n8n Connect" et cliquez sur Installer.
  2. Activation : Une fois l'installation terminée, activez le plugin.
  3. Dépendances : L'extension PHP cURL est requise pour ce plugin. Assurez-vous qu'elle est installée et activée sur votre système Jeedom.
  4. Configuration Initiale : Après l'activation, vous serez redirigé vers la page de configuration du plugin.

⚙️ Configuration

Après l'installation, vous devrez configurer la connexion globale à n8n, puis chaque équipement (workflow) que vous souhaitez contrôler :

1. Configuration Globale du Plugin

  1. Accédez à la configuration globale du plugin via Plugins > Gestion des plugins > n8n Connect > Configuration.
  2. URL de l'instance n8n : Saisissez l'adresse complète de votre instance n8n (ex: https://mon.n8n.local ou http://192.168.1.100:5678).
  3. Clé API : Entrez votre clé API n8n, générée dans n8n (Settings > API).
  4. Cliquez sur le bouton "Tester" pour vérifier la connexion à votre instance n8n.

2. Configuration des Équipements (Workflows)

Pour chaque workflow n8n que vous souhaitez contrôler :

  1. Allez dans Plugins > Communication > n8n Connect.

  2. Cliquez sur "Ajouter" pour créer un nouvel équipement.

  3. Paramètres Généraux :

    • Nom de l'équipement : Donnez un nom significatif à votre équipement (ex: "Workflow Lumières Salon").
    • Objet parent : Associez l'équipement à un objet Jeedom existant.
    • Catégorie : Attribuez une ou plusieurs catégories.
    • Options : Cochez Activer pour activer l'équipement et Visible pour l'afficher sur le dashboard.
  4. Paramètres Spécifiques :

    • Workflow : Cliquez sur le bouton de rafraîchissement () pour charger la liste de vos workflows n8n disponibles, puis sélectionnez le workflow désiré. Si la liste ne se charge pas, un champ de saisie manuelle de l'ID du workflow apparaîtra.
    • Webhook URL (Optionnel) : Si vous souhaitez déclencher ce workflow via une commande "Lancer", collez ici l'URL du webhook de votre workflow n8n.
    • Auto-actualisation : Définissez la fréquence de rafraîchissement des commandes infos de l'équipement.
  5. Sauvegarder : N'oubliez pas de cliquer sur Sauvegarder après avoir configuré votre équipement.

🖥️ Utilisation

Une fois votre équipement configuré et sauvegardé, les commandes d'information et d'action seront automatiquement créées.

  • Commandes d'Action :
    • Activer : Active le workflow correspondant dans n8n.
    • Désactiver : Désactive le workflow correspondant dans n8n.
    • Lancer : Envoie une requête HTTP POST à l'URL du webhook configurée pour le workflow (visible uniquement si une "Webhook URL" est renseignée).
  • Commandes d'Information :
    • État : Commande d'information binaire indiquant si le workflow est actif (1) ou inactif (0) dans n8n.

❓ Dépannage

  • Erreur HTTP 401 "unauthorized" : Vérifiez que l'URL de l'instance n8n et la Clé API sont correctement renseignées dans la configuration globale du plugin. Assurez-vous que l'API REST est activée dans n8n et que la clé API est valide et possède les permissions nécessaires.
  • "URL de webhook manquante" : Le champ "Webhook URL" doit être renseigné dans la configuration de l'équipement pour que la commande "Lancer" soit disponible.
  • "Erreur webhook : The requested webhook ... is not registered" : Le workflow n'est pas actif dans n8n, ou l'URL du webhook est incorrecte. Activez le workflow dans n8n et vérifiez l'exactitude de l'URL.
  • "Délai d'attente dépassé" : Vérifiez que votre instance n8n est en ligne et accessible depuis Jeedom.
  • Logs de diagnostic : Pour des informations détaillées, consultez les logs du plugin (Outils > Logs > n8nconnect).

🤝 Contribution

Les contributions sont les bienvenues ! Si vous souhaitez améliorer ce plugin, signaler un bug ou proposer de nouvelles fonctionnalités, n'hésitez pas à :

  1. Ouvrir une issue sur le dépôt GitHub.
  2. Soumettre une Pull Request avec vos modifications.

📜 Changelog

Consultez le changelog pour l'historique des versions et les nouvelles fonctionnalités.

⚖️ Licence

Ce plugin est distribué sous la licence AGPL.

About

⚡ Jeedom n8n Integration • Connect and control your n8n workflows from Jeedom, enabling seamless automation between the two platforms.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors