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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
|
"""
Create test fixture file set for pyenphase by scanning known endpoints on Envoy.
execute python fixture_collector.py --help for directions
Copy this file to the Home Assistant config folder. Open a terminal on your HA system
Navigate to the config folder and execute python fixture_collector.py
Alternatively copy and execute this file to a system with pyenphase installed and
network connectivity to your Home Assistant config folder and the Envoy.
"""
import argparse
import asyncio
import contextlib
import getpass
import json
import logging
import os
import zipfile
from datetime import datetime
from aiohttp import ClientResponse
from pyenphase.envoy import Envoy
from pyenphase.exceptions import (
EnvoyAuthenticationRequired,
EnvoyFirmwareFatalCheckError,
)
# logging.basicConfig(level=logging.WARNING)
_LOGGER = logging.getLogger(__name__)
DEFAULT_ENDPOINTS = [
"/info",
"/api/v1/production",
"/api/v1/production/inverters",
"/production.json",
"/production.json?details=1",
"/production",
"/ivp/ensemble/power",
"/ivp/ensemble/inventory",
"/ivp/ensemble/dry_contacts",
"/ivp/ensemble/status",
"/ivp/ensemble/secctrl",
"/ivp/ss/dry_contact_settings",
"/admin/lib/tariff",
"/ivp/ss/gen_config",
"/ivp/ss/gen_schedule",
"/ivp/sc/pvlimit",
"/ivp/ss/pel_settings",
"/ivp/ensemble/generator",
"/ivp/meters",
"/ivp/meters/readings",
"/ivp/pdm/device_data",
"/home",
"/inventory.json?deleted=1",
"/inv",
"/inventory",
"/ivp/pdm/energy",
"/ivp/meters/pvReading",
"/ivp/meters/gridReading",
"/ivp/meters/reports",
]
async def main(
envoy_address: str | None,
username: str | None,
password: str | None,
token: str | None,
verbose: bool = False,
label: str = "",
clean: bool = False,
endpoint_to_get: list[str] | None = None,
) -> None:
host_arg = envoy_address
env_host = os.environ.get("ENVOY_HOST")
host = host_arg or env_host or "envoy.local"
envoy = Envoy(host)
try:
await envoy.setup()
except EnvoyFirmwareFatalCheckError as err:
print(f"Could not connect to Envoy: {err.status_code} {err.status}")
await envoy.close()
return
try:
await envoy.authenticate(username=username, password=password, token=token)
except EnvoyAuthenticationRequired:
print("Could not authenticate with Envoy")
await envoy.close()
return
target_dir = f"enphase-{envoy.firmware}{label}"
with contextlib.suppress(FileExistsError):
os.mkdir(target_dir)
if verbose:
print(f"Created folder: {target_dir}")
end_points = endpoint_to_get if endpoint_to_get else DEFAULT_ENDPOINTS
assert envoy.auth # nosec
for end_point in end_points:
# url = envoy.auth.get_endpoint_url(end_point)
if verbose:
print(f"Reading: {end_point}")
try:
start_time: datetime = datetime.now()
response: ClientResponse = await envoy.request(end_point)
except Exception as ex:
_LOGGER.debug("Error getting %s", end_point, exc_info=ex)
continue
try:
response_text = await response.text()
end_time: datetime = datetime.now()
duration_seconds = round((end_time - start_time).total_seconds(), 3)
if verbose:
print(f"{end_point} reply text read in: {duration_seconds}")
except Exception as ex:
_LOGGER.debug("Error getting %s", end_point, exc_info=ex)
continue
file_name = (
end_point[1:]
.replace("/", "_")
.replace("?", "_")
.replace("=", "_")
.replace("&", "_")
.replace(" ", "_")
)
file_path = os.path.join(target_dir, file_name)
with open(file_path, "w", encoding="utf-8") as fixture_file:
fixture_file.write(response_text)
if verbose:
print(f"Creating: {fixture_file.name}")
with open(
os.path.join(target_dir, f"{file_name}_log.json"), "w", encoding="utf-8"
) as metadata_file:
# Remove potentially sensitive headers from being persisted to disk
sensitive = {
"authorization",
"cookie",
"set-cookie",
"x-auth-token",
"x-csrf-token",
"x-api-key",
}
safe_headers = {
k: v for k, v in response.headers.items() if k.lower() not in sensitive
}
metadata_file.write(
json.dumps(
{
"headers": dict(safe_headers),
"code": response.status,
"duration_seconds": duration_seconds,
}
)
)
if not clean or verbose:
print(f"Fixtures written to {target_dir}")
zip_file_name = f"{target_dir}.zip"
with zipfile.ZipFile(zip_file_name, "w") as zip_file:
for file_name in os.listdir(target_dir):
zip_file.write(os.path.join(target_dir, file_name), file_name)
if clean:
os.remove(os.path.join(target_dir, file_name))
print(f"Zip file written to {zip_file_name}")
if clean:
try:
os.rmdir(target_dir)
if verbose:
print(f"Removed {target_dir}")
except OSError as err:
print(f"Could not clean folder: {err.strerror}")
except FileNotFoundError:
pass
await envoy.close()
def _read_ha_config(file_path: str) -> dict[str, list[str | None]]:
result: dict[str, list[str | None]] = {}
try:
with open(file_path) as fp:
content = json.load(fp)
except (FileNotFoundError, ValueError):
return result
if content:
for entry in content["data"]["entries"]:
if entry["domain"] != "enphase_envoy" or entry["source"] == "ignore":
continue
data = entry["data"]
unique_id = entry["unique_id"]
result[unique_id] = [
data["host"],
data["username"],
data["password"],
data["token"],
]
return result
if __name__ == "__main__":
description = (
"Scan Enphase Envoy for endpoint list usable for pyenphase test fixtures. \
Creates output folder enphase-<firmware>[label] with results of scan.\
Zips content of created folder into enphase-<firmware>[label].zip.\
\
Optionally collect specified endpoints only.\
"
)
parser = argparse.ArgumentParser(description=description)
parser.add_argument(
"-d", "--debug", help="Enable debug logging", action="store_true"
)
parser.add_argument("-v", "--verbose", action="store_true")
parser.add_argument(
"-c",
"--clean",
help="Remove created folder, but keep zip file",
action="store_true",
)
parser.add_argument(
"-l", "--label", help="Label to append to output folder and zip file names"
)
parser.add_argument(
"-r",
"--readhaconfig",
const=".",
nargs="?",
dest="ha_config_folder",
help="Read envoyname, username, password and token from HA config folder.\
Use -r path_to_ha_config_folder. Default is current folder.\
Overrides any specified username, password and token.\
Reads <path_to_ha_config_folder>/.storage/core.config_entries.\
",
)
parser.add_argument(
"envoyname",
nargs="?",
default="envoy.local",
help="Envoy Name or IP address. IP is preferred, default is envoy.local",
)
parser.add_argument(
"-u", "--username", help="Username (for Envoy or for Enphase token website)"
)
parser.add_argument(
"-p", "--password", help="Password (blank or for Enphase token website)"
)
parser.add_argument(
"-t",
"--token",
help="Enphase owner token or @path_to_file to read token from file",
)
parser.add_argument(
"-e",
"--endpoint",
help="Comma-separated list of endpoints to read (e.g. /info,/home). Endpoints start with /.",
)
args = parser.parse_args()
if args.debug:
logging.basicConfig(level=logging.DEBUG)
host = args.envoyname
username: str | None = args.username
password: str | None = args.password
read_ha_config: str = args.ha_config_folder
verbose: bool = args.verbose
endpoints: list[str] | None = (
[ep.strip() for ep in args.endpoint.split(",") if ep.strip()]
if args.endpoint
else []
)
config_entries: dict[str, list[str | None]] = {}
target_ha_file: str = ""
if args.ha_config_folder:
target_ha_file = os.path.join(read_ha_config, ".storage", "core.config_entries")
config_entries = _read_ha_config(target_ha_file)
else:
username = args.username
password = args.password
token = args.token
if not token:
token = os.environ.get("ENVOY_TOKEN", getpass.getpass("Enter the token: "))
if token and token[0] == "@":
try:
with open(token[1:]) as f:
token = f.read()
except FileNotFoundError:
token = None
if not username and not token:
username = os.environ.get("ENVOY_USERNAME", input("Enter the Username: "))
if not password and not token:
password = os.environ.get(
"ENVOY_PASSWORD", getpass.getpass("Enter the Password: ")
)
config_entries.update({"": [host, username, password, token]})
for sn, configs in config_entries.items():
host, username, password, token = configs
if verbose:
print(f"Using {host} sn: {sn}, {target_ha_file}")
asyncio.run(
main(
envoy_address=host,
username=username,
password=password,
token=token,
verbose=verbose,
label=args.label or "",
clean=args.clean,
endpoint_to_get=endpoints,
)
)
|