diff --git a/.gitignore b/.gitignore index e23698aa..26ce0cc6 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ build .DS_Store node_modules .env -.docusaurus \ No newline at end of file +.docusaurus +.idea/ diff --git a/docs/integrations/node-red.md b/docs/integrations/node-red.md new file mode 100644 index 00000000..c3f0439d --- /dev/null +++ b/docs/integrations/node-red.md @@ -0,0 +1,41 @@ +--- +id: node-red +title: Node-RED +sidebar_label: Node-RED +--- + + +In this tutorial, we will show you how to integrate [Node-RED](https://nodered.org/) to Gladys Assistant. + +This will allow you to connect hardware devices, APIs and online services. + +## Activate Node-RED +In Gladys, go to in `Integrations / Node-RED`. + +Gladys needs to install a container. Don’t worry, it’s all been automated. + +Go to the `Configuration` section and click on the **Enable** button. After a few moments (the time depends on your Raspberry Pi model and your bandwidth), you should visualize all the initialized elements and the links between each in green. + + +![Etat des services Node-RED](../../static/img/docs/en/configuration/node-red/node-red_etat_services_en.png) + + +## Connect to Node-RED + +You can open the Node-RED interface by clicking on the link +:warning: Attention, the link is not accessible from Gladys Plus + +![Lien Node-RED](../../static/img/docs/en/configuration/node-red/node-red_link_en.png) + +You arrive at your local Node-RED instance. + +![Login Node-RED](../../static/img/docs/en/configuration/node-red/node-red_login_en.png) + +To connect, you must use the connection information provided in the `Configuration` section. + +## Use + +You can now create your Node-RED flows + +![Node-RED](../../static/img/docs/en/configuration/node-red/node-red_en.png) + diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/integrations/node-red.md b/i18n/fr/docusaurus-plugin-content-docs/current/integrations/node-red.md new file mode 100644 index 00000000..cc4a1d09 --- /dev/null +++ b/i18n/fr/docusaurus-plugin-content-docs/current/integrations/node-red.md @@ -0,0 +1,40 @@ +--- +id: node-red +title: Node-RED +sidebar_label: Node-RED +--- + +Dans ce tutoriel, nous allons vous expliquer qu'il est possible d'intégrer [Node-RED](https://nodered.org/) à Gladys Assistant. + +Vous pourrez ainsi connecter des périphériques matériels, des API et des services en ligne. + +## Activez Node-RED +Dans Gladys, Rendez-vous dans `Intégrations / Node-RED`. + +Gladys a besoin d'installer un container. Ne vous inquiétez pas, tout cela a été automatisé. + +Rendez-vous dans la partie `Configuration` et cliquez sur le bouton **Activer**. Après quelques instants (le temps dépend de votre modèle de Raspberry Pi et de votre bande passante), vous devriez visualiser tous les éléments démarrés et les liens entre chacun au vert. + + +![Etat des services Node-RED](../../../../../static/img/docs/fr/configuration/node-red/node-red_etat_services_fr.png) + + +## Se connecter à Node-RED + +Vous pouvez ouvrir l'interface de Node-Red en cliquant sur le lien +:warning: Attention, le lien n'est pas accessible depuis Gladys Plus + +![Lien Node-RED](../../../../../static/img/docs/fr/configuration/node-red/node-red_link_fr.png) + +Vous arrivez sur votre instance locale de Node-RED. + +![Login Node-RED](../../../../../static/img/docs/fr/configuration/node-red/node-red_login_fr.png) + +Pour vous connecter, il faut utiliser les informations de connection fourni dans la partie `Configuration` + +## Utilisation + +Vous pouvez maintenant créer vos flux Node-RED + +![Node-RED](../../../../../static/img/docs/fr/configuration/node-red/node-red_fr.png) + diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/integrations/zigbee2mqtt.md b/i18n/fr/docusaurus-plugin-content-docs/current/integrations/zigbee2mqtt.md index 899a5f33..663a6ef3 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/integrations/zigbee2mqtt.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/integrations/zigbee2mqtt.md @@ -56,7 +56,7 @@ Cela permet de charger directement la configuration Zigbee2mqtt correspondante. ## Activez Zigbee2Mqtt -Une fois votre dongle configuré, Gladys a besoin d'installer deux containers (MQTT et Zigbee2Mqtt) pour utiliser le dongle et communqiuer avec tous vos appareils. Ne vous inquiétez pas, tout cela a été automatisé. +Une fois votre dongle configuré, Gladys a besoin d'installer deux containers (MQTT et Zigbee2Mqtt) pour utiliser le dongle et communiquer avec tous vos appareils. Ne vous inquiétez pas, tout cela a été automatisé. Rendez-vous dans la partie `Configuration` et cliquez sur le bouton **Activer Zigbee2mqtt**. Après quelques instants (le temps dépend de votre modèle de Raspberry Pi et de votre bande passante), vous devriez visualiser tous les éléments démarrés et les liens entre chacun au vert. diff --git a/sidebars.js b/sidebars.js index 3e14639a..62d69fb3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -38,6 +38,7 @@ module.exports = { "integrations/zigbee2mqtt", "integrations/zwave", "integrations/telegram", + "integrations/node-red", ], }, { diff --git a/static/img/docs/en/configuration/node-red/node-red_en.png b/static/img/docs/en/configuration/node-red/node-red_en.png new file mode 100644 index 00000000..8f32f4ed Binary files /dev/null and b/static/img/docs/en/configuration/node-red/node-red_en.png differ diff --git a/static/img/docs/en/configuration/node-red/node-red_etat_services_en.png b/static/img/docs/en/configuration/node-red/node-red_etat_services_en.png new file mode 100644 index 00000000..c6805e04 Binary files /dev/null and b/static/img/docs/en/configuration/node-red/node-red_etat_services_en.png differ diff --git a/static/img/docs/en/configuration/node-red/node-red_link_en.png b/static/img/docs/en/configuration/node-red/node-red_link_en.png new file mode 100644 index 00000000..989d8042 Binary files /dev/null and b/static/img/docs/en/configuration/node-red/node-red_link_en.png differ diff --git a/static/img/docs/en/configuration/node-red/node-red_login_en.png b/static/img/docs/en/configuration/node-red/node-red_login_en.png new file mode 100644 index 00000000..57d5c61a Binary files /dev/null and b/static/img/docs/en/configuration/node-red/node-red_login_en.png differ diff --git a/static/img/docs/fr/configuration/node-red/node-red_etat_services_fr.png b/static/img/docs/fr/configuration/node-red/node-red_etat_services_fr.png new file mode 100644 index 00000000..95ca9f63 Binary files /dev/null and b/static/img/docs/fr/configuration/node-red/node-red_etat_services_fr.png differ diff --git a/static/img/docs/fr/configuration/node-red/node-red_fr.png b/static/img/docs/fr/configuration/node-red/node-red_fr.png new file mode 100644 index 00000000..8f32f4ed Binary files /dev/null and b/static/img/docs/fr/configuration/node-red/node-red_fr.png differ diff --git a/static/img/docs/fr/configuration/node-red/node-red_link_fr.png b/static/img/docs/fr/configuration/node-red/node-red_link_fr.png new file mode 100644 index 00000000..208141f9 Binary files /dev/null and b/static/img/docs/fr/configuration/node-red/node-red_link_fr.png differ diff --git a/static/img/docs/fr/configuration/node-red/node-red_login_fr.png b/static/img/docs/fr/configuration/node-red/node-red_login_fr.png new file mode 100644 index 00000000..57d5c61a Binary files /dev/null and b/static/img/docs/fr/configuration/node-red/node-red_login_fr.png differ