Skip to content

Commit

Permalink
feat: add old documentation Netatmo and old image
Browse files Browse the repository at this point in the history
  • Loading branch information
Terdious committed Dec 21, 2023
1 parent dfbe06e commit 39171b0
Show file tree
Hide file tree
Showing 15 changed files with 245 additions and 4 deletions.
141 changes: 141 additions & 0 deletions docs/integrations/netatmo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
---
id: netatmo
title: Netatmo
sidebar_label: Netatmo
---

## Prerequisites

### Step 1 - Compatible devices and mobile applications Netatmo

To be able to add your Netatmo devices in Gladys, they must first be added in their respective applications that you will have to download from the play store or the Apple store.
Below are listed only devices compatible with Gladys:

#### "Security" application :
![Configure an app 1](/en/img/docs/configuration/netatmo/configure-netatmo-application-security.jpg)
- "NOC" outdoor surveillance cameras
- "NACamera" indoor surveillance cameras
- "NIS" sirens associated with indoor cameras
- "NACamDoorTag" door / window opening sensors

#### "Netatmo" application :
![Configure an app 2](/en/img/docs/configuration/netatmo/configure-netatmo-application-netatmo.jpg)
- "NAMain" weather stations
- Rain gauges associated with weather stations
- Anemometers associated with weather stations
- Outdoor hygrometers associated with weather stations
- Indoor hygrometers associated with weather stations (up to 3)

#### "Energy" application :
![Configure an app 3](/en/img/docs/configuration/netatmo/configure-netatmo-application-energie.jpg)
- "NRV" valves
- "NATherm1" thermostats

#### "Home Coach" application :
![Configure an app 4](/en/img/docs/configuration/netatmo/configure-netatmo-application-home-coach.jpg)
- "NHC" Healthy homes coach

### Step 2 - Netatmo connect

Then, you must go to the [Netatmo connect](https://dev.netatmo.com/) page and click on the "LOG IN" link to create an account with your email address and a password.

#### Creating an "app"

Go to your [My app](https://dev.netatmo.com/apps/) page and click on the "Create" button to create a link to your Gladys account. Enter the necessary information (fields with an \*) as the example below :
![Configure an api 1](/en/img/docs/configuration/netatmo/configure-netatmo-connect-1.jpg)

#### Retrieving connection client credentials

By clicking on "Save", you will then have access to the necessary information in the box below (see [Step 1 of the tutorial](/en/docs/integrations/netatmo#step-1---compatible-devices-and-mobile-applications-netatmo))
![Configure an api 2](/en/img/docs/configuration/netatmo/configure-netatmo-connect-2.jpg)

## Tutorial

To add your Netatmo devices in Gladys, go to `Integrations / Netatmo`.
![Netatmo Integration](/en/img/docs/configuration/netatmo/integrations-netatmo.jpg)

### Step 1: Netatmo API connection

From the `Settings` tab,
![Netatmo Integration - To Parameter](/en/img/docs/configuration/netatmo/integrations-netatmo-vers-parametre.jpg)
Enter the information retrieved during [the previous step](/en/docs/integrations/netatmo#step-2---netatmo-connect) :

- Enter your email address for connecting to your "Netatmo connect" account
- The password of the same account
- The customer ID,
- The secret client,

Finally click on "Save".
After a few seconds you should now be connected with the Netatmo API.
![Netatmo Integration - Parameter](/en/img/docs/configuration/netatmo/integrations-netatmo-parametre.jpg)

### Step 2: Discovery Netatmo devices

In the `Discovery Netatmo devices` tab,
![Netatmo Integration - Discovery](/en/img/docs/configuration/netatmo/integrations-netatmo-decouverte-appareils.jpg)

You will find all the devices that you had previously configured on the different applications [from step 1 of the prerequisites](/en/docs/integrations/netatmo#step-1---compatible-devices-and-mobile-applications-netatmo). They are referenced by their name defined in their respective application. You can integrate them with a simple click on the "Add" button. The button then changes to "Already created".

![Netatmo Integration - Discovery - Already created](/en/img/docs/configuration/netatmo/integrations-netatmo-decouverte-appareils-deja-cree.jpg)

On this page you will also find an "Update datas" button to refresh the device names if they are changed in Netatmo applications.

![Netatmo Integration - Discovery - Update](/en/img/docs/configuration/netatmo/integrations-netatmo-decouverte-appareils-mettre-a-jour.jpg)


### Step 3: Define a room for the devices / Modify the functionalities

In the `Netatmo devices` tab, this time you will find the added devices with their characteristics.

![Netatmo Integration - Netatmo devices](/en/img/docs/configuration/netatmo/integrations-netatmo-appareils-netatmo.jpg)

#### 1) Define a room

To be able to display a device on the dashboard, you must first associated a room to it. Select it in the following drop-down menu:
![Netatmo Integration - Netatmo devices - Select room](/en/img/docs/configuration/netatmo/integrations-netatmo-appareils-netatmo-selection-piece.jpg)

Then click on the "Save" button.

#### 2) Modify features

You can change the display name of the features that will appear on the home page. In addition, some features can be displayed in different ways. Click on the "Modify" button of a device plug :

- The index health of the Home Coach:
![Integration Netatmo - Home Coach Index](/en/img/docs/configuration/netatmo/integrations-netatmo-appareils-netatmo-modifier-home-coach.jpg)
- Display in numbers from 0 to 4:

![Integration Netatmo - Home Coach Index-Number](/en/img/docs/configuration/netatmo/integrations-netatmo-dashboard-home-coach-index-number.jpg)

- Or display in state:

![Integration Netatmo - Homes Coach Index-State](/en/img/docs/configuration/netatmo/integrations-netatmo-dashboard-home-coach-index-string.jpg)

- The wind angle of the weather station anemometer
![Integration Netatmo - Anemometer Angle](/en/img/docs/configuration/netatmo/integrations-netatmo-appareils-netatmo-modifier-anemometre.jpg)

- Display in degrees:

![Integration Netatmo - Anemometer Angle-Degrees](/en/img/docs/configuration/netatmo/integrations-netatmo-dashboard-anemometre-angle-degrees.jpg)

- Or display in cardinal point:

![Integration Netatmo - Anemometer Angle-Cardinal Point](/en/img/docs/configuration/netatmo/integrations-netatmo-dashboard-anemometre-angle-point-cardinal.jpg)

Don't forget to save your changes before leaving the page !!

## Progress and forecast of service evolution

### February 2021

To date, the following devices :
- Smoke detector "NSD",
- Bell "NDB"

Cannot be traced back to Gladys for the moment because the API does not offer status feedback. However, the "webhooks" are under development via Gladys Plus. For all those who have a subscription, it will soon be possible to retrieve the status feedbacks of these devices.

The status feedbacks of all the devices seen in [step 1 of the prerequisites](/en/docs/integrations/netatmo#step-1---compatible-devices-and-mobile-applications-netatmo) are functional. The controls are being programmed.

You're done! You can now add the devices and features you want to enjoy on your home page or create your alert scenes.



Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
id: netatmo
title: Netatmo
sidebar_label: Netatmo
---

## Prérequis

### Etape 1 - Appareils compatibles et applications mobiles Netatmo

Pour pouvoir ajouter vos appareils Netatmo dans Gladys, ceux-ci doivent au préalable être ajoutés dans leurs applications respectives que vous devrez télécharger sur le play store ou l'apple store.
Ci-dessous ne sont référencés que les appareils compatibles avec Gladys :

#### Application "Energie" :
![Configurer une app 3](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-configure-application-energie.jpg)
- Les thermostats "NATherm1"

### Etape 2 - Netatmo connect

Vous devez ensuite vous rendre sur la page [Netatmo connect](https://dev.netatmo.com/) et cliquer sur le lien "LOG IN" pour créer un compte avec votre adresse mail et un mot de passe.

#### Création d'une "app"

Rendez vous ensuite sur votre page [My app](https://dev.netatmo.com/apps/) et cliquer sur le bouton "Create" pour créer un lien vers votre compte Gladys. Entrez les informations nécessaires (champs avec une \*) comme l'exemple ci-dessous :
![Configurer une api 1](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-configure-connect-1.jpg)

#### Récupération des identifiants clients de connection

En cliquant sur "Save", vous aurez ensuite accès aux informations nécessaires dans le cadre en-dessous (voir [Etape 1 du tutoriel](/fr/docs/integrations/netatmo#etape-1--connexion-api-netatmo))

![Configurer une api 2](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-configure-connect-2.jpg)

## Tutoriel

Pour ajouter vos appareils Netatmo dans Gladys, allez dans `Intégrations / Netatmo`.

![Integration Netatmo](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations.jpg)

### Etape 1 : Connexion API Netatmo

Depuis l'onglet `Paramètre`,
![Integration Netatmo - Vers Paramètre](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations-vers-parametre.jpg)
Entrez les informations récupérées lors de [l'étape précédente](/fr/docs/netatmo#integrations/etape-2---netatmo-connect) :

- Entrez votre adresse mail de connection à votre compte "Netatmo connect"
- Le mot de passe de ce même compte
- Le client ID,
- Le client secret,

Enfin cliquez sur "Sauvegarder".
Après quelques secondes, vous devriez maintenant être connecté avec l'API Netatmo.
![Integration Netatmo - Paramètre](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations-parametre.jpg)

### Etape 2 : Découverte des appareils Netatmo

Dans l'onglet `Découverte appareils Netatmo`,
![Integration Netatmo - Découverte](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations-decouverte-appareils.jpg)

Vous retrouvez tous les appareils que vous aviez précédemment configurés sur les différentes applications [de l'étape 1 des prérequis](/fr/docs/integrations/netatmo#etape-1---appareils-compatibles-et-applications-mobiles-netatmo). Ils sont référencés par leur nom défini dans leur application respective. Vous pouvez intégrer ceux-ci d'un simple clique sur le bouton "Ajouter". Le bouton passent alors en "Déjà créé".

![Integration Netatmo - Découverte - Déjà créé](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations-decouverte-appareils-deja-cree.jpg)

Sur cette page vous retrouvé également un bouton "Mettre à jour" pour effectuer un rafraichissement des noms des appareils en cas de changement de ces derniers dans les applications Netatmo.

![Integration Netatmo - Découverte - Mettre à jour](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations-decouverte-appareils-mettre-a-jour.jpg)


### Etape 3 : Définir une pièce aux appareils et modification des fonctionnalités

Dans l'onglet `Appareils Netatmo`, vous retrouvez cette fois les appareils ajoutés avec leurs caractéristiques.

![Integration Netatmo - Appareils Netatmo](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations-appareils-netatmo.jpg)

#### 1) Définir une pièce

Pour pouvoir afficher un appareil sur le dashboard, il faut en premier lieu lui associer une pièce. Sélectionner celle-ci dans le menu déroulant suivant :
![Netatmo Integration - Netatmo devices - Select room](../../../../../static/img/docs/fr/configuration/netatmo/netatmo-integrations-appareils-netatmo-selection-piece.jpg)
Puis cliquer sur le bouton "Sauvegarder".

#### 2) Modifier les fonctionnalités

Vous pouvez modifier le nom d'affichage des fonctionnalités qui apparaitront sur la page d'accueil. De plus certaines fonctionnalités peuvent être affichées de différentes manière. Cliquer sur le bouton "Modifier" d'une fiche d'appareil :

N'oubliez pas de sauvegarder vos modifications avant de quitter la page !!

## Avancement et prévision d'évolution du service

### Janvier 2023

A ce jour, les appareils suivants :
- Détecteur de fumée "NSD",
- Sonnette "NDB"

Ne peuvent être remontés vers Gladys car l'API ne propose pas de retour d'état. Toutefois, les "webhooks" sont en cours de développement via Gladys Plus. Pour tout ceux qui disposent d'un abonnement, il serait prochainement possible de récupérer les retours d'états de ces appareils.

Les retours d'états de tous les appareils vue à [l'étape 1 des prérequis](/fr/docs/integrations/netatmo#etape-1---appareils-compatibles-et-applications-mobiles-netatmo) sont fonctionnels. Les commandes sont en cours de programmation.

Et voilà ! Vous pouvez maintenant ajouter les appareils et fonctionnalités dont vous souhaitez profiter sur votre page d'accueil ou encore créer vos scènes d'alertes.
9 changes: 5 additions & 4 deletions scripts/load_integrations.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const AUTHORIZED_DOC_ID = [
"zwave",
"tasmota",
"tp-link",
"netatmo",
"zigbee2mqtt",
];

Expand Down Expand Up @@ -113,9 +114,9 @@ const downloadImages = async (products, lang) => {
}).catch((err) => {
console.log(
"Cannot download image " +
product.imageUrl +
" " +
product.imageName
product.imageUrl +
" " +
product.imageName
);
throw err;
});
Expand Down Expand Up @@ -152,7 +153,7 @@ const getExistingIntegrations = (lang) => {
try {
const existingDoc = require(`../integrations/${lang}/${docId}.json`);
existingIntegrations = existingIntegrations.concat(existingDoc);
} catch (e) {}
} catch (e) { }
});
return existingIntegrations;
};
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ module.exports = {
"integrations/homekit",
"integrations/mqtt",
"integrations/nextcloud-talk",
"integrations/netatmo",
"integrations/node-red",
"integrations/openweather",
"integrations/openai",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 39171b0

Please sign in to comment.