Skip to content

Commit

Permalink
Merge pull request #5 from geckoflume/main
Browse files Browse the repository at this point in the history
Updated README and translations
  • Loading branch information
sebcaps authored Jun 3, 2023
2 parents 4199b92 + 10e2056 commit c1e9dc7
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Atmo France pour Home Assistant

Composant pour exposer les niveaux de pollution prévu pour le jour même.
Composant pour exposer les niveaux de pollution prévus pour le jour même.

Données fournies par Atmo France et les agences régionales.
Données fournies par Atmo France et les agences régionales.
Voir https://www.atmo-france.org/ pour l'accès web.

L'intégration expose les données d'Atmo France pour une commune donnée.
Les données exposés sont :
L'intégration expose les données d'Atmo France pour une commune donnée.
Les données exposées sont :
- Niveau de pollution Dioxyde d'Azote (NO<sub>2</sub>)
- Niveau de pollution Ozone (O<sub>3</sub>)
- Niveau de pollution Dioxyde de Souffre (SO<sub>2</sub>)
- Niveau de pollution Dioxyde de Soufre (SO<sub>2</sub>)
- Niveau de pollution Particules fines <2.5 µm (Pm25)
- Niveau de pollution Particules fines <10 µm (Pm10)
- Niveau global de qualité de l'air.
- Niveau global de qualité de l'air

## Installation

Utilisez [hacs](https://hacs.xyz/).
Utilisez [HACS](https://hacs.xyz/).
[![Ouvrez votre instance Home Assistant et ouvrez un référentiel dans la boutique communautaire Home Assistant.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=sebcaps&repository=atmofrance&category=integration)

## Configuration
Expand All @@ -31,22 +31,22 @@ Utilisez [hacs](https://hacs.xyz/).

La méthode de configuration consiste à utiliser l'interface utilisateur.

Il faut tout d'abord saisir ces [identifiants d'accés](#obtenir-un-accès-pour-les-api-atmo-france) à l'API.
Il faut tout d'abord saisir ses [identifiants d'accès](#obtenir-un-accès-pour-les-api-atmo-france) à l'API.

![image info](/img/authent.png)

Puis selectionner le code postal de la commune dont on souhaite obtenir les données.
Puis sélectionner le code postal de la commune dont on souhaite obtenir les données.

![image info](/img/location.png)
>**Note:**
>L'API se base sur le code INSEE. La récupération du code INSEE se fait via l'intégration, mais il peut y avoir plusieur communes (donc plusieurs code INSEE) pour un même code postal. Dans ce cas, une étape supplémentaire demande de préciser la commune (sélectionnable dans une liste) pour ne récupérer qu'un code INSEE.
>**Note :**
>L'API se base sur le code INSEE. La récupération du code INSEE se fait via l'intégration, mais il peut y avoir plusieurs communes (donc plusieurs codes INSEE) pour un même code postal. Dans ce cas, une étape supplémentaire demande de préciser la commune (sélectionnable dans une liste) pour ne récupérer qu'un code INSEE.
![image info](/img/multiloc.png)

### Données

Les informations présentées sont les niveaux de pollution sur une échelle de 1 (Bon) à 5 (Trés Mauvais).

Le libellé du niveau est présent sous forme d'attribut du sensor. Est également présent dans les attributs, la date et heure (UTC) de la mise à jour des données par AtmoFrance. **Les données sont mise à jour une fois par jour par AtmoFrance**
Le libellé du niveau est présent sous forme d'attribut du sensor. Sont également présents dans les attributs, la date et heure (UTC) de la mise à jour des données par AtmoFrance. **Les données sont mises à jour une fois par jour par Atmo France.**

![image info](/img/attributs.png)
2 changes: 1 addition & 1 deletion custom_components/atmofrance/const.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class AtmoFranceSensorEntityDescription(
),
AtmoFranceSensorEntityDescription(
key="code_so2",
name="Dioxyde de souffre",
name="Dioxyde de soufre",
device_class=SensorDeviceClass.AQI,
icon="mdi:molecule",
state_class=SensorStateClass.MEASUREMENT,
Expand Down
8 changes: 4 additions & 4 deletions custom_components/atmofrance/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"config": {
"error": {
"auth": "Impossible to get auth token. Check your credentials",
"noinsee": "Impossible to get INSEE code. Check zip code and logs."
"noinsee": "Impossible to get INSEE code. Check ZIP code and logs."
},
"step": {
"user": {
Expand All @@ -15,16 +15,16 @@
},
"location": {
"data": {
"code_postal": "Zip Code"
"code_postal": "ZIP code"
},
"description": "Set your zip code",
"description": "Set your ZIP code",
"title": "Location"
},
"multilocation": {
"data": {
"city": "City"
},
"title": "Many code found",
"title": "Many codes found",
"description": "Select the city"
}
}
Expand Down
4 changes: 2 additions & 2 deletions custom_components/atmofrance/translations/fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"config": {
"error": {
"auth": "Impossible de recupérer le token. Vérifiez vos identifiants",
"noinsee": "Impossible de recupérer le code INSEE. Vérifiez le code postal et les logs.."
"noinsee": "Impossible de récupérer le code INSEE. Vérifiez le code postal et les logs."
},
"step": {
"user": {
Expand All @@ -15,7 +15,7 @@
},
"location": {
"data": {
"code_postal": "Code Postal"
"code_postal": "Code postal"
},
"description": "Saisissez votre code postal",
"title": "Localisation"
Expand Down

0 comments on commit c1e9dc7

Please sign in to comment.