Requests

The pyenphase package can be used to send any request to the Envoy. Either to obtain data from endpoints not already collected, or send PUT or POST requests to the Envoy. Access to the used endpoints is enabled by the Authorization level set during authentication. The request response is returned to the caller and not stored in the Envoy data model.

envoy = Envoy(host_ip_or_name)
await envoy.setup()
await envoy.authenticate(username=username, password=password, token=token)

myresponse: aiohttp.ClientResponse = await envoy.request('/my/own/endpoint')
status_code = myresponse.status_code

myjson_data = await myresponse.json()

You can run the package using requests only (without calling probe and update), which provides an API into the Envoy without using the internally pre-configured data collections.

V2 Request

As of version 2, envoy.request returns an aiohttp.ClientResponse as result. This is a breaking change from version 1 where an httpx.Response was returned.

To access the response data use either aiohttp.ClientResponse.read() to access the whole response body as bytes, aiohttp.ClientResponse.text() to get response body as decoded str or aiohttp.ClientResponse.json() to read the body as JSON.

Note that the JSON method is the standard python decoder JSON.loads. To use another one use the read() method in combination with your favorite decoder.