File: usage.md

package info (click to toggle)
pyenphase 2.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,056 kB
  • sloc: python: 8,964; xml: 95; makefile: 15; sh: 4
file content (26 lines) | stat: -rw-r--r-- 576 bytes parent folder | download
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
# Usage

The pyenphase package provides the [Envoy class](#pyenphase.Envoy) to collect data from [Enphase IQ Gateway](https://enphase.com/en-us/products-and-services/envoy-and-combiner). To use this package, import classes and modules from it:

```python
from pyenphase import Envoy, EnvoyData

envoy: Envoy = Envoy(host)
await envoy.setup()

await envoy.authenticate(username=username, password=password, token=token)
data: EnvoyData = await envoy.update()

await envoy.close()
```

```{toctree}
:maxdepth: 3
:hidden:

usage_intro
usage_authentication
requests
advanced

```