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
|
# Data collection
## Setup
Access to the Envoy device requires specifying its IP address or DNS name when constructing the {py:class}`pyenphase.Envoy`.
Next, the Envoy serial number and active firmware version should be obtained to identify which authentication method is required. Use {py:meth}`pyenphase.Envoy.setup`.
Once the firmware version is known, [authentication](./usage_authentication.md#authentication) can take place using the required parameters for the firmware. The {py:meth}`pyenphase.Envoy.authenticate` method requires a username, password, and, in some cases, a JWT token—[depending on the active firmware](./usage_authentication.md#authentication).
```python
from pyenphase import Envoy, EnvoyData
envoy = Envoy(host_ip_or_name)
await envoy.setup()
print(f'Envoy {envoy.host} running {envoy.firmware}, sn: {envoy.serial_number}')
await envoy.authenticate(username=username, password=password, token=token)
```
## Close
The Envoy class uses an [aiohttp client session](https://docs.aiohttp.org/en/stable/client_reference.html)
for HTTP communication. The caller can optionally specify a client session when constructing the {py:class}`pyenphase.Envoy`.
If no client session is specified, pyenphase will create one.
The client session created by pyenphase must be closed at application exit. Use {py:meth}`pyenphase.Envoy.close` to close the created session.
If you supplied your own aiohttp ClientSession, {py:meth}`pyenphase.Envoy.close` will not close it; you remain responsible for closing it.
```python
from pyenphase import Envoy, EnvoyData
envoy = Envoy(host_ip_or_name)
await envoy.setup()
print(f'Envoy {envoy.host} running {envoy.firmware}, sn: {envoy.serial_number}')
await envoy.authenticate(username=username, password=password, token=token)
data: EnvoyData = await envoy.update()
await envoy.close()
```
## Update
Upon authentication completion, data can be collected (repeatedly) using {py:meth}`pyenphase.Envoy.update`.
```python
while True:
data: EnvoyData = await envoy.update()
print(f'Watts: {data.system_production.watts_now}')
print(f'TodaysEnergy: {data.system_production.watt_hours_today}')
print(f'LifetimeEnergy: {data.system_production.watt_hours_lifetime}')
print(f'Last7DaysEnergy: {data.system_production.watt_hours_last_7_days}')
await asyncio.sleep(some_time)
```
For all available data refer to [Data](./data.md).
## Probe
When data is first collected, the update method will perform a probe of the Envoy to determine what data is actually available. This may vary by model or running firmware version. This probing also provides the data for various envoy properties.
If the need exists to inspect properties before first data collection, use the [probe method](#pyenphase.Envoy.probe).
```python
from pyenphase import Envoy, EnvoyData
envoy = Envoy(host_ip_or_name)
await envoy.setup()
print(f'Envoy {envoy.host} running {envoy.firmware}, sn: {envoy.serial_number}')
await envoy.authenticate(username=username, password=password, token=token)
await envoy.probe()
print(f'Phases: {envoy.phase_count}')
production_ct = 'installed' if envoy.production_meter_type else 'not installed'
consumption_ct = 'installed' if envoy.consumption_meter_type else 'not installed'
print(f'This envoy has Production CT {production_ct} and Consumption CT {consumption_ct}')
```
|
