Skip to content

Commit 0f08fc3

Browse files
author
Xavier Berger
committed
feat: add Enphase Envoy and IQ Gateway power meter documentation in English and French
1 parent 397d442 commit 0f08fc3

5 files changed

Lines changed: 174 additions & 0 deletions

File tree

‎docs/en/power_meter_enphase_envoy.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Power Meter - Enphase Envoy
2+
3+
This power meter reads the grid import/export power from an Enphase Envoy gateway using the local HTTP API. It is compatible with older Envoy and Envoy-S devices that do not require token-based authentication.
4+
5+
## Requirements
6+
7+
- **IP Address or Hostname**: The IP address or hostname of the Envoy gateway (e.g., `192.168.1.50` or `envoy.local`).
8+
9+
## Configuration
10+
11+
To use this power meter, include the following in your main YAML file:
12+
13+
```yaml
14+
packages:
15+
solar_router:
16+
url: https://github.com/hacf-fr/Solar-Router-for-ESPHome
17+
refresh: 1d
18+
files:
19+
- path: solar_router/common.yaml
20+
- path: solar_router/power_meter_enphase_envoy.yaml
21+
vars:
22+
power_meter_ip_address: "192.168.1.50"
23+
```
24+
25+
## API Details
26+
27+
- **Endpoint**: `GET http://<envoy>/production.json`
28+
- **Measurement**: The `net-consumption` measurement (`consumption[1].wNow`) represents the power exchanged with the grid:
29+
- **Positive value**: Energy is drawn from the grid.
30+
- **Negative value**: Energy is pushed to the grid (solar surplus).
31+
32+
## Notes
33+
34+
- This power meter is designed for Enphase Envoy devices running firmware versions older than 7.x.
35+
- No authentication is required for this configuration.

‎docs/en/power_meter_enphase_iq_gateway.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Power Meter - Enphase IQ Gateway
2+
3+
This power meter reads the grid import/export power from an Enphase IQ Gateway using the local HTTPS API with token-based authentication. It is required for all modern Enphase IQ Gateways (formerly "Envoy") running firmware 7.x and above.
4+
5+
## Requirements
6+
7+
- **IP Address or Hostname**: The IP address or hostname of the IQ Gateway (e.g., `192.168.1.50` or `envoy.local`).
8+
- **JWT Token**: A JWT token used to authenticate with the IQ Gateway.
9+
10+
## Obtaining the JWT Token
11+
12+
To obtain the JWT token:
13+
14+
1. Log in to [https://enlighten.enphaseenergy.com](https://enlighten.enphaseenergy.com).
15+
2. Navigate to your system, then open your browser developer tools (F12).
16+
3. Go to **Application → Cookies** and copy the value of `enlighten-4-token`.
17+
18+
Alternatively, use the community tool: [https://entrez.enphaseenergy.com](https://entrez.enphaseenergy.com) (generates a local-access token).
19+
20+
**Note**: Tokens are valid for 1 year. Renew when expired.
21+
22+
## Configuration
23+
24+
To use this power meter, include the following in your main YAML file:
25+
26+
```yaml
27+
packages:
28+
solar_router:
29+
url: https://github.com/hacf-fr/Solar-Router-for-ESPHome
30+
refresh: 1d
31+
files:
32+
- path: solar_router/common.yaml
33+
- path: solar_router/power_meter_enphase_iq_gateway.yaml
34+
vars:
35+
power_meter_ip_address: "192.168.1.50"
36+
enphase_token: "eyJhbGciOi..."
37+
```
38+
39+
## API Details
40+
41+
- **Endpoint**: `GET https://<gateway>/production.json`
42+
- **Authentication**: JWT Bearer token sent in the `Authorization` header.
43+
- **SSL Verification**: Disabled (IQ Gateway uses a self-signed certificate).
44+
- **Measurement**: The `net-consumption` measurement (`consumption[1].wNow`) represents the power exchanged with the grid:
45+
- **Positive value**: Energy is drawn from the grid.
46+
- **Negative value**: Energy is pushed to the grid (solar surplus).
47+
48+
## Notes
49+
50+
- This power meter is designed for Enphase IQ Gateways running firmware 7.x and above.
51+
- SSL verification is disabled due to the use of a self-signed certificate by the IQ Gateway.

‎docs/fr/power_meter_enphase_envoy.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Compteur de puissance - Enphase Envoy
2+
3+
Ce compteur de puissance lit la puissance d'importation/exportation du réseau à partir d'une passerelle Enphase Envoy en utilisant l'API HTTP locale. Il est compatible avec les anciens appareils Envoy et Envoy-S qui ne nécessitent pas d'authentification basée sur un token.
4+
5+
## Prérequis
6+
7+
- **Adresse IP ou nom d'hôte** : L'adresse IP ou le nom d'hôte de la passerelle Envoy (par exemple, `192.168.1.50` ou `envoy.local`).
8+
9+
## Configuration
10+
11+
Pour utiliser ce compteur de puissance, incluez ce qui suit dans votre fichier YAML principal :
12+
13+
```yaml
14+
packages:
15+
solar_router:
16+
url: https://github.com/hacf-fr/Solar-Router-for-ESPHome
17+
refresh: 1d
18+
files:
19+
- path: solar_router/common.yaml
20+
- path: solar_router/power_meter_enphase_envoy.yaml
21+
vars:
22+
power_meter_ip_address: "192.168.1.50"
23+
```
24+
25+
## Détails de l'API
26+
27+
- **Endpoint** : `GET http://<envoy>/production.json`
28+
- **Mesure** : La mesure `net-consumption` (`consumption[1].wNow`) représente la puissance échangée avec le réseau :
29+
- **Valeur positive** : L'énergie est tirée du réseau.
30+
- **Valeur négative** : L'énergie est poussée vers le réseau (surplus solaire).
31+
32+
## Remarques
33+
34+
- Ce compteur de puissance est conçu pour les appareils Enphase Envoy exécutant des versions de firmware antérieures à 7.x.
35+
- Aucune authentification n'est requise pour cette configuration.

‎docs/fr/power_meter_enphase_iq_gateway.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Compteur de puissance - Enphase IQ Gateway
2+
3+
Ce compteur de puissance lit la puissance d'importation/exportation du réseau à partir d'une passerelle Enphase IQ Gateway en utilisant l'API HTTPS locale avec authentification basée sur un token. Il est requis pour toutes les passerelles Enphase IQ Gateway modernes (anciennement "Envoy") exécutant le firmware 7.x et versions ultérieures.
4+
5+
## Prérequis
6+
7+
- **Adresse IP ou nom d'hôte** : L'adresse IP ou le nom d'hôte de la passerelle IQ Gateway (par exemple, `192.168.1.50` ou `envoy.local`).
8+
- **JWT Token** : Un token JWT utilisé pour s'authentifier avec la passerelle IQ Gateway.
9+
10+
## Obtention du JWT Token
11+
12+
Pour obtenir le JWT token :
13+
14+
1. Connectez-vous à [https://enlighten.enphaseenergy.com](https://enlighten.enphaseenergy.com).
15+
2. Accédez à votre système, puis ouvrez les outils de développement de votre navigateur (F12).
16+
3. Allez dans **Application → Cookies** et copiez la valeur de `enlighten-4-token`.
17+
18+
Alternativement, utilisez l'outil communautaire : [https://entrez.enphaseenergy.com](https://entrez.enphaseenergy.com) (génère un token d'accès local).
19+
20+
**Note** : Les tokens sont valides pour 1 an. Renouvelez-les lorsqu'ils expirent.
21+
22+
## Configuration
23+
24+
Pour utiliser ce compteur de puissance, incluez ce qui suit dans votre fichier YAML principal :
25+
26+
```yaml
27+
packages:
28+
solar_router:
29+
url: https://github.com/hacf-fr/Solar-Router-for-ESPHome
30+
refresh: 1d
31+
files:
32+
- path: solar_router/common.yaml
33+
- path: solar_router/power_meter_enphase_iq_gateway.yaml
34+
vars:
35+
power_meter_ip_address: "192.168.1.50"
36+
enphase_token: "eyJhbGciOi..."
37+
```
38+
39+
## Détails de l'API
40+
41+
- **Endpoint** : `GET https://<gateway>/production.json`
42+
- **Authentification** : Le token JWT Bearer est envoyé dans l'en-tête `Authorization`.
43+
- **Vérification SSL** : Désactivée (la passerelle IQ Gateway utilise un certificat auto-signé).
44+
- **Mesure** : La mesure `net-consumption` (`consumption[1].wNow`) représente la puissance échangée avec le réseau :
45+
- **Valeur positive** : L'énergie est tirée du réseau.
46+
- **Valeur négative** : L'énergie est poussée vers le réseau (surplus solaire).
47+
48+
## Remarques
49+
50+
- Ce compteur de puissance est conçu pour les passerelles Enphase IQ Gateway exécutant le firmware 7.x et versions ultérieures.
51+
- La vérification SSL est désactivée en raison de l'utilisation d'un certificat auto-signé par la passerelle IQ Gateway.

‎mkdocs.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ nav:
1919
- With Solar Optimizer integration: exemple_with_SO_integration.md
2020
- Power Meter:
2121
- Overview: power_meter.md
22+
- Enphase Envoy: power_meter_enphase_envoy.md
23+
- Enphase IQ Gateway: power_meter_enphase_iq_gateway.md
2224
- Fronius: power_meter_fronius.md
2325
- Home Assistant: power_meter_home_assistant.md
2426
- JSY-MK-194T: power_meter_jsy-mk-194t.md

0 commit comments

Comments
 (0)