1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
# Endpoint JSON
This section describes the Envoy data used by the library.
Enphase's installer resource website documents the IQ Gateway local API. Because it’s a dynamic resource, use the filters for “Communication Device” and select the Envoy or IQ Gateway types. This [example link](https://enphase.com/installers/resources/documentation/communication) pre-selects communication documents. Use the product filters for Envoy and the “Design and Tech Briefs” topic filter.
A wealth of information on the Enphase local Envoy api is available from [Matthew1471's github repository](https://github.com/Matthew1471/Enphase-API), which is an excellent resource.
## /api/v1/production
### description
This endpoint is used for production data of a non‑metered Envoy or a metered Envoy without CTs installed. It only contains aggregated phase data. Data is measured/calculated by the Envoy.
Also see [Known Issues](known_issues.md#production--consumption-data).
### JSON
```{literalinclude} ./json_data/api_v1_production.json
:language: json
```
## /api/v1/production/inverters
### description
This is the endpoint used for basic inverter production data.
### JSON
```{literalinclude} ./json_data/api_v1_production_inverters.json
:language: json
```
## /ivp/meters
### description
This is the endpoint used for installed CT meters configuration.
### JSON
```{literalinclude} ./json_data/ivp_meters.json
:language: json
```
## /ivp/meters/readings
### description
This is the endpoint used for CT meter readings.
### JSON
```{literalinclude} ./json_data/ivp_meters_readings.json
:language: json
```
## /ivp/pdm/device_data
### description
This is the endpoint used for detailed inverter data.
Also see [Known Issues](known_issues.md#inverter-device-data).
### JSON
```{literalinclude} ./json_data/ivp_pdm_device_data.json
:language: json
```
## /production.json?details=1
### description
This is the default endpoint for production and consumption data. It contains data for aggregated and individual phases. Data is measured/calculated by the Envoy. Individual phase data is in the `lines` segment.
- For non-metered Envoy, the `type: "eim"` sections are not present.
- For Envoy-metered without a [_production_ CT](data_ctmeter.md#ct-model):
- the `production` item where `type == "eim"` and `measurementType == "production"` has `activeCount == 0`.
- For Envoy-metered with:
- a [_net-consumption_ CT](data_ctmeter.md#ct-model), the _total-consumption_ data is calculated by the Envoy.
- a [_total-consumption_ CT](data_ctmeter.md#ct-model), the _net-consumption_ data is calculated by the Envoy.
- For Envoy-metered without any _consumption_ CT:
- the `consumption` item where `type == "eim"` and `measurementType == "net-consumption"` has `activeCount == 0`;
- the `consumption` item where `type == "eim"` and `measurementType == "total-consumption"` has `activeCount == 0`.
Also see [Known Issues](known_issues.md#production--consumption-data).
### JSON
```{literalinclude} ./json_data/production_details.json
:language: json
```
## /production
### description
This is an endpoint for production and consumption data used when older firmware is running in the Envoy and the [standard endpoint](#productionjsondetails1) is not providing data. It only contains data for aggregated phases, no individual phase data is available. Data is measured/calculated by the Envoy.
- For non-metered Envoy, the `type: "eim"` sections are not present.
- For Envoy-metered without a [_production_ CT](data_ctmeter.md#ct-model):
- the `production` item where `type == "eim"` and `measurementType == "production"` has `activeCount == 0`.
- For Envoy-metered with:
- a [_net-consumption_ CT](data_ctmeter.md#ct-model), the _total-consumption_ data is calculated by the Envoy.
- a [_total-consumption_ CT](data_ctmeter.md#ct-model), the _net-consumption_ data is calculated by the Envoy.
- For Envoy-metered without any _consumption_ CT:
- the `consumption` item where `type == "eim"` and `measurementType == "net-consumption"` has `activeCount == 0`;
- the `consumption` item where `type == "eim"` and `measurementType == "total-consumption"` has `activeCount == 0`.
### Known issues
Also see [Known Issues](known_issues.md#production--consumption-data).
### JSON
```{literalinclude} ./json_data/production.json
:language: json
```
|
