[ { "path": ".gitignore", "content": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n#vscode\n.vscode/" }, { "path": "README.md", "content": "[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration#readme)\n\nThis is a HACS custom integration for [enphase envoys/IQ Gateways](https://enphase.com/en-us/products-and-services/envoy-and-combiner) with firmware version 7.X. This integration is based off work done by @jesserizzo, @gtdiehl and @DanBeard, with some changes to report individual battery status. \n\nIt still supports Envoys with firmware versions before 7.x including R3 versions for legacy models.\n\nWorks with older models that only have (some) production metrics (ie. Envoy-C R or LCD), newer models with only production metrics (IQ Gateway / ENVOY-S Standard) and models that offer both production and consumption metrics (ie. Envoy-S metered).\n\n# Installation\n\n1. Install [HACS](https://hacs.xyz/) if you haven't already\n2. Add this repository as a [custom integration repository](https://hacs.xyz/docs/faq/custom_repositories) in HACS\n4. Restart home assistant\n5. Add the integration through the home assistant configuration flow, [specify settings as needed](#initial-configuration-details)\n7. The integration has some run-time configuration options, [set these as desired](#runtime-configuration) after startup.\n8. The integration has some hidden entities, [enable these](#disabled-entities) to use these.\n\n\n# Usage\n\n## Initial Configuration details\n\nThe initial configuration window requires you to enter the details how to access the Envoy. Following fields have to be filled.\n\n### Host\n\nEnter the IP address of the Envoy. If the Envoy is auto-discovered it will be pre-filled. The IP address may be an ipv4 or ipv6 address.\n\n### Username and Password\n\nSpecify the username and password to access the envoy data. What username and password to use depends on the ENVOY type and/or it's firmware version:\n\n- If your IQ Gateway / Envoy-S is on Firmware 7.x or later, use your Enphase Enlighten username and password. Make sure to enable the 'Use Enlighten' option at the bottom of the form.\n\n- For older models and ENVOY-S with firmware before 7.x use `envoy` without a password, `installer` without a password or a valid username and password for the type.\n\n- For older models that require username `installer` with a password, this can be obtained with this: [tool](https://thecomputerperson.wordpress.com/2016/08/28/reverse-engineering-the-enphase-installer-toolkit/).\n- In some cases, you need to use the username `envoy` with the last 6 digits of the unit's serial number as password.\n\nSee [the Enphase documentation](https://support.enphase.com/s/article/What-is-the-Username-and-Password-for-the-Administration-page-of-the-Envoy-local-interface) for more details on various units.\n\n**Note** This integration does not provide the additional data accessible by Enphase Installer or DIY accounts, only data accessible by Home owner accounts is provided. Using an Installer or DIY account may or may not work work, but currently just the Home owner data is retrieved.\n\n## Serial number\n\nSpecify the Envoy serial number. If the Envoy is auto-discovered it will be pre-filled.\n\n### Use Enlighten\n\nEnable this option with IQ Gateway/ENVOY-S Firmware 7.x or later that require Enphase tokens for authentication. It will use the username and password to retrieve the authentication token from the Enphase website, cache it and use it to access the Envoy.\n\n## Runtime configuration\n\nOnce the Envoy has been running and is operational, the following configuration items are available:\n\n### Scan Interval - Time between Entity updates\n\nBy default the Envoy data is collected every 60 seconds. One can change the setting to what is desired with a minimum of every 5 seconds. Upon changing the value, reload the integration (or restart Home Assistant).\n\nWhat the optimal scan frequency is depends on the Envoy model. Models without meters typically update the inverter data every 5 minutes. Models using meters update measurements way more frequent, probably every second or so. Hence the default of 60 seconds as starting point. Some models may have capacity issues running at high refresh rates, so no single recipe is available.\n\n**Note** Envoy Metered has a data streaming option to bring in data as it comes available which is not currently supported by this integration.\n\n### Timeout for single Envoy Page\nSpecifies the timeout for each single data get to the Envoy. Defaults to 30 seconds. Shortening this time does not make the Envoy response faster, lengthening it will allow a slow Envoy more time to respond before time-out occurs.\n\n### How many retries in getting an Envoy response\nSpecifies how many times a retry should be attempted after the first one failed. Must be at least 1 to allow for automatic token updates. Typically do not change this setting. Increasing may help in poor network conditions.\n\n### Time between 2 retries\nOptionally a wait time can be inserted between 2 retries. Only change this in special circumstances.\n\n### Overall Timeout\nWhen getting data from the Envoy, an overall timer is started. If not all data is returned when the timer expires, the data collection is considered timed-out and all data is set to unavailable. Intent is catch all if data collection is never returning. Do not change this setting, unless Timeout for single envoy page or number of retries needs to be increased. In that case increase this overall timer value as well to prevent it to timeout the data collection. To get a feel for needed time, enable the debug mode on the envoy and inspect timing of a full collection cycle.\n\n### Do not use production json\nThis switch, intended for use with the Envoy-s Metered only, will tell the integration not to use production endpoint on the Envoy. The production endpoint is a relatively slow endpoint on the Envoy and reportedly crashes or restarts at times resulting in timeouts. \n\nThe Envoy-s Metered (only) has other, faster endpoints that provide a subset of what production endpoint offers. This subset is lacking the daily total and last 7 day total values which are only provided by the production endpoint. If you are more interested in faster updates from the CT clamps and have less interest in the Daily total or last 7 day total then this may be an option to consider. The values for today total and last 7 day total will show as unavailable. The values for production and consumption CT clamps will update with every collection cycle. The values for the inverters will continue to update every 5 minutes as before.\n\n## Disabled entities\nThe integration comes with some entities disabled by default. These only apply when using metered Envoy with CT clamps. If desired enable these by opening the HA entities window in the settings menu. Remove the filter for not shown entities by pushing the `clear` button. Then enter disabled or enphase in the search filter to find the disabled entities. Use the selector box to select the ones to enable and use the `enable selected` button to enable them.\n\n# Firmware and its impact\n\nEnphase model offering differs in various countries as does firmware versions and releases. Not all firmware is released in all countries and as a result firmware versions may differ largely in time. Enphase does push new firmware to the IQ Gateway / Envoy, 'not necessarily letting the home owner know'. In the past this has broken this integration as API details and change information is limited available. See the [Enphase documentation website](https://enphase.com/installers/resources/documentation/communication) for information available.\n\n# Different models have different features\n\nThis integration supports various models but as models have different features they will not all provide the same data. Brief list of reported data below.\n\n## ENVOY C / R / LCD\n\n- Current power production, today's, last 7 days and lifetime energy production. And Active inverter count, which is disabled by default.\n\n## IQ Gateway / ENVOY S standard (non metered)\n\n- Current power production, today's, last 7 days and lifetime energy production.\n- Current power production for each connected inverter.\n\n## IQ Gateway / ENVOY S standard metered\n\nWhat data is available depends on how many current transformer clamps (CT) are installed and what currents they measure. Both production and consumption clamps can be installed, each for up to 3 phases or multiple circuits on their own breaker in single phase setup. The consumption clamps can be installed in 2 modes, 'Load with Solar'or 'Load only'. To measure net-consumption (energy import/export to the grid) it should be installedin Load with Solar mode. If in 'Load only' mode only total-consumption (to the house) can be reported.\n\n### with connected current transformer clamps\n\n- Current power production and consumption, today's, last 7 days and lifetime energy production and consumption over all phases.\n- Current power production and consumption, today's, last 7 days and lifetime energy production and consumption for each individual phase named L1, L2 and L3.\n- Current net power consumption and lifetime net energy production (export) and consumption (import) over all phases.\n- Current net power consumption and lifetime net energy production (export) and consumption (import) for each individual phase named L1, L2 and L3.\n- Next entities are disabled by default and need to be enabled in the entities configuration screen\n - Power production for each connected inverter.\n - Power factor over all phases.\n - Power factor for each individual phase named L1, L2 and L3.\n - Voltage over all phases. (Be aware this is the summed Voltage of all measured phases!)\n - Voltage for each individual phase named L1, L2 and L3.\n - Frequency over all phases.\n - Frequency for each individual phase named L1, L2 and L3.\n - Production and consumption Current (amps) over all phases.\n - Production and consumption Current (amps) for each individual phase named L1, L2 and L3.\n\n**Note** If you have CT clamps on a single phase / breaker circuit only, the L1 production and consumption phase sensors will show same data as the over all phases sensors.\n\n### without connected current transformer clamps\n\nThe current firmware (D7.6.175 and probably some other right before and after it) without CT clamps connected and configured does obviously not report these measurements. But for some reason it is only reporting:\n\n- Current power production and lifetime energy production. Today's and last 7 day energy production reportedly are both solid 0.\n- Lifetime Energy production reportedly resets to zero roughly every 1.19 MWh.\n- Current power production for each connected inverter.\n\n**Note** - When adding (or removing) CT clamps after use witouth CT clamps this will cause (huge) step changes/spikes in life time values when CT readings are now from the CT clamps (or longer available) and the wrapping value is no longer/now used. \n\n# Device and Entities\n\nThe naming scheme used is based on the Envoy and inverter Serial numbers.\n\n## Device\n\nA device `Envoy ` is created with sensor entities for accessible data.\n\n## Envoy Sensors\n\n|Sensor name|Sensor ID|Units|remarks|\n|-----|-----|----|----|\n|Envoy \\ Current Power Production|sensor.Envoy_\\_current_power_production|W||\n|Envoy \\ Today's Energy production|sensor.Envoy_\\_todays_energy_production|Wh|1|\n|Envoy \\ Last Seven Days Energy Production|sensor.Envoy_\\_last_seven_days_energy_production|Wh|1|\n|Envoy \\ Lifetime Energy Production|sensor.Envoy_\\_lifetime_energy_production|Wh|2|\n|Envoy \\ Lifetime Net Energy Production|sensor.Envoy_\\_lifetime_net_energy_production|Wh|4|\n|Envoy \\ Current Power Consumption|sensor.Envoy_\\_current_power_consumption|W||\n|Envoy \\ Current Net Power Consumption|sensor.Envoy_\\_current_net_power_consumption|W|4|\n|Envoy \\ Today's Energy Consumption|sensor.Envoy_\\_todays_energy_consumption|Wh|4,5|\n|Envoy \\ Last Seven Days Energy Consumption|sensor.Envoy_\\_last_seven_days_energy_consumption|Wh|4|\n|Envoy \\ Lifetime Energy Consumption|sensor.Envoy_\\_lifetime_energy_consumption|Wh|4|\n|Envoy \\ Lifetime Net Energy Consumption|sensor.Envoy_\\_lifetime_net_energy_consumption|Wh|4,7,8|\n|Envoy \\ Power Factor|sensor.Envoy_\\_pf||4,9|\n|Envoy \\ Voltage|sensor.Envoy_\\_voltage|V|4,9|\n|Envoy \\ Frequency|sensor.Envoy_\\_frequency|Wh|4,9|\n|Envoy \\ Consumption Current|sensor.Envoy_\\_consumption_Current|A|4,9|\n|Envoy \\ Production Current|sensor.Envoy_\\_production_Current|A|4,9|\n|Envoy \\ Active Inverter Count|sensor.Envoy_\\_active_inverter_count||9,10|\n||||\n|Grid Status |binary_sensor.grid_status|On/Off|3|\n||||\n|Envoy \\ Current Power Production L\\|sensor.Envoy_\\_current_power_production_l\\|W|4,5|\n|Envoy \\ Today's Energy production L\\|sensor.Envoy_\\_todays_energy_production_l\\|Wh|4,5|\n|Envoy \\ Last Seven Days Energy Production L\\|sensor.Envoy_\\_last_seven_days_energy_production_l\\|Wh|4,5|\n|Envoy \\ Lifetime Energy Production L\\|sensor.Envoy_\\_lifetime_energy_consumption_l\\|Wh|4,5|\n|Envoy \\ Lifetime Net Energy Production L\\|sensor.Envoy_\\_lifetime_net_energy_production_l\\|Wh|4,5,7,8|\n|Envoy \\ Current Power Consumption L\\|sensor.Envoy_\\_current_power_consumption_l\\|W|4,5|\n|Envoy \\ Current Net Power Consumption L\\|sensor.Envoy_\\_current_net_power_consumption_l\\|W|4,5|\n|Envoy \\ Today's Energy Consumption L\\|sensor.Envoy_\\_todays_energy_consumption_l\\|Wh|4,5,6|\n|Envoy \\ Last Seven Days Energy Consumption L\\|sensor.Envoy_\\_last_seven_days_energy_consumption L\\|Wh|4,5,6|\n|Envoy \\ Lifetime Energy Consumption L\\|sensor.Envoy_\\_lifetime_energy_consumption_l\\|Wh|4,5,6|\n|Envoy \\ Lifetime Net Energy Consumption L\\|sensor.Envoy_\\_lifetime_net_energy_consumption_l\\|Wh|4,5,6,7,8|\n|Envoy \\ Power Factor L\\|sensor.Envoy_\\_pf||4,5,9|\n|Envoy \\ Voltage L\\|sensor.Envoy_\\_voltage|V|4,5,9|\n|Envoy \\ Frequency L\\|sensor.Envoy_\\_frequency|Wh|4,5,9|\n|Envoy \\ Consumption Current L\\|sensor.Envoy_\\_consumption_Current|A|4,5,9|\n|Envoy \\ Production Current L\\|sensor.Envoy_\\_production_Current|A|4,5,9|\n|Envoy \\ |sensor.Envoy_\\_|Wh|4,5|\n\n1 Always zero for Envoy Metered without meters. \n2 Reportedly resets to zero when reaching ~1.92MWh for Envoy Metered without meters. \n3 Not available on Legacy models and ENVOY Standard with recent firmware. \n4 Only on Envoy metered with configured and connected meters. \n5 L\\ L1,L2,L3, availability depends on which and how many phases are connected and configured. \n6 Reportedly always zero on Envoy metered with Firmware D8. \n7 In V0.0.18 renamed to Lifetime Net Energy Consumption /Production from Export Index/Import Import in v0.0.17. Old Entities will show as unavailable. \n8 Only when consumption CT is installed in 'Load with Solar' mode. In 'Load only' mode values have no meaning. \n9 Disabled by default and must be enabled in the entities configuration screen. These are values from the consumption CT. \n10 Only available on legacy Envoy.\n\n## Inverter Sensors\n\nFor each inverter a sensor for current power production is created.\n\n|Sensor name|Sensor ID|UNits|remarks|\n|-----|-----|----|----|\n|Envoy \\ Inverter \\|sensor.Envoy_\\\\_Inverter_\\|W|1|\n\n1: Not available on Legacy models\n\n**Note** the entity 'Last Updated' for each inverter is currently not provided. \n\n**Note** As can be noted the Envoy serial number is part of the inverter sensor id and name. Internally the unique_id for it is the inverter serial number. When changing your setup by moving inverters to a new/different Envoy it will require some preparation/research how this will work out. (Statistics (history) is stored by sensor id)\n\n## Battery Sensors\n\nFor each battery a sensor for percent full is created as well as sensors for overall battery percentage, overall battery capacity, overall energy charged and discharged are created.\n\n|Sensor name|Sensor ID|Units|remarks|\n|-----|-----|----|----|\n|Envoy \\ Battery \\|sensor.Envoy_\\\\_Battery_\\|%|1|\n|Envoy \\ Total Battery Percentage|sensor.Envoy_\\\\_total_battery_percentage|%|1|\n|Envoy \\ Current Battery Capacity|sensor.Envoy_\\\\_current_battery_capacity|Wh|1|\n|Envoy \\ Battery Energy Charged|sensor.Envoy_\\\\_battery_energy_charged|Wh|1|\n|Envoy \\ Battery Energy Discharged|sensor.Envoy_\\\\_battery_energy_charged|Wh|1|\n\n1: Not available on Legacy models and ENVOYS-S Standard\n\n# How to switch to Enphase token authorization\n\nOnce the envoy received the new firmware that requires token authorization, data collection will fail. To switch to the token usage execute next steps:\n\n- [Install](#installation) the Custom integration using HACS\n- In Home Assistant go to the Enphase Envoy integration and delete it.\n- Restart Home Assistant\n- The envoy will be auto-discovered again. If not add an Envoy Integration manually.\n- In the configuration screen now use your Enphase Enlighten username and password and enable the 'Use Enlighten' option.\n- Once it's configured it will continue reporting data in the same entities.\n- Optionally change the default time interval from 60 to what is preferred.\n\n# Troubleshooting\n\nWhen issues occur with this integration some items to check are:\n\n- Use the `Download Diagnostics` button in the Envoy Device page or the Enphase Integration page menu. It will download settings and recent data of the Envoy and provide some key information.\n- What model are you using. This will drive what can be expected.\n- What firmware is your model using, Was a firmware update recently pushed to the device?\n- Enable debug logging and let it run for a couple of minutes, disable it again and the log file will download. Check for obvious errors and be prepared to share it as needed for troubleshooting. Any tokens, usernames or passwords for the Envoy integration are not visible, but there may be sensitive information of other integrations that are being used.\n - All data collected is logged in lines like `Fetched from https://192.168.01.10/some_url: :`. Inspecting these provides insight in what and how successful data is collected.\n - The Envoy model it thinks its dealing with is reported in a line containing: `Using Model: P (HTTPs, Metering enabled: False, Get Inverters: True)`. (Model PC is envoy metered, P is Standard and R/LCD with FW >= R3.9 and P0 is Legacy/C/R/LCD with FW < R3.9>)\n- When configuring the Envoy for token use it will reach out to the Enphase Enlighten website to obtain a token. Reportedly the Enphase website is not equally responsive every moment of the day, week, moth, year and the setup will fail. At this moment the only answer to that is your perseverance or just try at another moment.\n- The token lifetime for Home Owner accounts is currently 1 year. The token is cached, eliminating the need to connect to Enphase each reload or restart. When the token is expired or some other authorization hiccup occurs a new token will be obtained. If that is needed at a moment it can't connect to Enphase it will try until success but in the mean time no data is collected from the Envoy. When using an Installer or DIY account this may work as well but the lifetime is 12 hours and refresh is way more frequent.\n- The Envoy integration supports zeroconf for auto detection and changes of IP addresses for the Envoy. It will not switch to an IPV6 address if the default network interface is running ipv4 or the other way around.It supports both IPV4 and IPV6. To change between these when default interface change IP type, remove and re-add the Envoy.\n- When an error is reported during the initial configuration, inspect the home-assistant.log file in the /config folder. It will reveal what happened:\n - Validate input, getdata returned RuntimeError: Could not Authenticate with Enlighten, status: 401, : Check if Enphase username and/or password are correct\n - Validate input, getdata returned RuntimeError: Could not get enlighten token, status: 403, : Make sure envoy serialnumber is correct and connected to your Enphase account\n - Validate input, getdata returned HTTPError: All connection attempts failed : failure to connect to envoy. : Validate if correct IP address of the Envoy is used\n - Fetched (1 of 2) in 0.0 sec from http://x.x.x.x/production.json?details=1: : : Was 'use Enlighten' checked when using tokens or validate username/pw used for legacy devices.\n- Lifetime Net Energy Consumption / Production shows 0 or incorrect values. This is the case when the Consumption CT is not available or installed in Load only mode. \n" }, { "path": "custom_components/enphase_envoy_custom/__init__.py", "content": "\"\"\"The Enphase Envoy integration.\"\"\"\nfrom __future__ import annotations\n\nfrom datetime import timedelta\nimport logging\n\nimport async_timeout\nfrom .envoy_reader import EnvoyReader\nimport httpx\nfrom numpy import isin\n\nfrom homeassistant.config_entries import ConfigEntry\nfrom homeassistant.const import CONF_HOST, CONF_NAME, CONF_PASSWORD, CONF_USERNAME\nfrom homeassistant.core import HomeAssistant\nfrom homeassistant.exceptions import ConfigEntryAuthFailed\nfrom homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed\nfrom homeassistant.helpers.storage import Store\n\nfrom .const import COORDINATOR, DOMAIN, NAME, PLATFORMS, SENSORS, CONF_USE_ENLIGHTEN, CONF_SERIAL, PHASE_SENSORS, DEFAULT_SCAN_INTERVAL\n\nSCAN_INTERVAL = timedelta(seconds=60)\nSTORAGE_KEY = \"envoy\"\nSTORAGE_VERSION = 1\nFETCH_RETRIES = 1\nFETCH_TIMEOUT_SECONDS = 30\nFETCH_HOLDOFF_SECONDS = 0\nCOLLECTION_TIMEOUT_SECONDS = 55\n\n_LOGGER = logging.getLogger(__name__)\n\n\nasync def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:\n \"\"\"Set up Enphase Envoy from a config entry.\"\"\"\n\n config = entry.data\n options = entry.options\n name = config[CONF_NAME]\n\n # Setup persistent storage, to save tokens between home assistant restarts\n store = Store(hass, STORAGE_VERSION, \".\".join([STORAGE_KEY, entry.entry_id]))\n\n envoy_reader = EnvoyReader(\n config[CONF_HOST],\n username=config[CONF_USERNAME],\n password=config[CONF_PASSWORD],\n enlighten_user=config[CONF_USERNAME],\n enlighten_pass=config[CONF_PASSWORD],\n inverters=True,\n# async_client=get_async_client(hass),\n use_enlighten_owner_token=config.get(CONF_USE_ENLIGHTEN, False),\n enlighten_serial_num=config[CONF_SERIAL],\n https_flag='s' if config.get(CONF_USE_ENLIGHTEN, False) else '',\n store=store,\n fetch_retries=options.get(\"data_fetch_retry_count\", FETCH_RETRIES),\n fetch_timeout_seconds=options.get(\"data_fetch_timeout_seconds\", FETCH_TIMEOUT_SECONDS),\n fetch_holdoff_seconds=options.get(\"data_fetch_holdoff_seconds\", FETCH_HOLDOFF_SECONDS),\n do_not_use_production_json=options.get(\"do_not_use_production_json\",False),\n )\n await envoy_reader._sync_store()\n\n async def async_update_data():\n \"\"\"Fetch data from API endpoint.\"\"\"\n data = {}\n async with async_timeout.timeout(options.get(\"data_collection_timeout_seconds\", COLLECTION_TIMEOUT_SECONDS)):\n try:\n await envoy_reader.getData()\n except httpx.HTTPStatusError as err:\n raise ConfigEntryAuthFailed from err\n except httpx.HTTPError as err:\n raise UpdateFailed(f\"Error communicating with API: {err}\") from err\n\n for description in SENSORS:\n if description.key == \"inverters\":\n data[\n \"inverters_production\"\n ] = await envoy_reader.inverters_production()\n\n elif description.key == \"batteries\":\n battery_data = await envoy_reader.battery_storage()\n if isinstance(battery_data, list) and len(battery_data) > 0:\n battery_dict = {}\n for item in battery_data:\n battery_dict[item[\"serial_num\"]] = item\n\n data[description.key] = battery_dict\n\n elif (description.key not in [\"current_battery_capacity\", \"total_battery_percentage\"]):\n data[description.key] = await getattr(\n envoy_reader, description.key\n )()\n\n for description in PHASE_SENSORS:\n if description.key[:-2] in [\n \"none_known_at_this_time_\"\n ]:\n # call phase function for these\n data[description.key] = await getattr(envoy_reader, description.key[:-3]+\"_phase\")( description.key[-2:].lower())\n\n else:\n \n #catchall for non-specified phase sensors\n #get attributes for phase sensors based on key name\n #Removes _L1, _L2 or _L3 from key to call base non-phased function\n #Pass l1, l2 or l3 as parameter to _phase function\n data[description.key] = await getattr(envoy_reader, description.key[:-3])( description.key[-2:].lower())\n \n \n data[\"grid_status\"] = await envoy_reader.grid_status()\n data[\"envoy_info\"] = await envoy_reader.envoy_info()\n\n _LOGGER.debug(\"Retrieved data from API: %s\", data)\n\n await envoy_reader._sync_store()\n \n return data\n\n coordinator = DataUpdateCoordinator(\n hass,\n _LOGGER,\n name=f\"envoy {name}\",\n update_method=async_update_data,\n update_interval=timedelta(\n seconds=options.get(\"data_interval\", DEFAULT_SCAN_INTERVAL)\n )\n )\n\n try:\n await coordinator.async_config_entry_first_refresh()\n except ConfigEntryAuthFailed:\n envoy_reader.get_inverters = False\n await coordinator.async_config_entry_first_refresh()\n\n if not entry.unique_id:\n try:\n serial = await envoy_reader.get_full_serial_number()\n except httpx.HTTPError:\n pass\n else:\n hass.config_entries.async_update_entry(entry, unique_id=serial)\n\n hass.data.setdefault(DOMAIN, {})[entry.entry_id] = {\n COORDINATOR: coordinator,\n NAME: name,\n }\n\n await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)\n\n return True\n\n\nasync def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:\n \"\"\"Unload a config entry.\"\"\"\n unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)\n if unload_ok:\n hass.data[DOMAIN].pop(entry.entry_id)\n return unload_ok\n" }, { "path": "custom_components/enphase_envoy_custom/binary_sensor.py", "content": "from homeassistant.core import HomeAssistant\nfrom homeassistant.config_entries import ConfigEntry\nfrom homeassistant.helpers.entity_platform import AddEntitiesCallback\nfrom homeassistant.helpers.update_coordinator import CoordinatorEntity\nfrom homeassistant.components.binary_sensor import BinarySensorEntity\nfrom homeassistant.helpers.entity import DeviceInfo\n\nfrom .const import COORDINATOR, DOMAIN, NAME, BINARY_SENSORS, ICON\n\nasync def async_setup_entry(\n hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback\n) -> None:\n data = hass.data[DOMAIN][config_entry.entry_id]\n coordinator = data[COORDINATOR]\n name = data[NAME]\n\n entities = []\n for sensor_description in BINARY_SENSORS:\n if sensor_description.key == \"grid_status\":\n if coordinator.data.get(\"grid_status\") is not None:\n entities.append(\n EnvoyGridStatusEntity(\n sensor_description,\n sensor_description.name,\n name,\n config_entry.unique_id,\n None,\n coordinator,\n )\n )\n\n async_add_entities(entities)\n\n\nclass EnvoyGridStatusEntity(CoordinatorEntity, BinarySensorEntity):\n def __init__(\n self,\n description,\n name,\n device_name,\n device_serial_number,\n serial_number,\n coordinator,\n ):\n self.entity_description = description\n self._name = name\n self._serial_number = serial_number\n self._device_name = device_name\n self._device_serial_number = device_serial_number\n CoordinatorEntity.__init__(self, coordinator)\n\n @property\n def icon(self):\n \"\"\"Icon to use in the frontend, if any.\"\"\"\n return ICON\n\n @property\n def name(self):\n \"\"\"Return the name of the sensor.\"\"\"\n return self._name\n\n @property\n def unique_id(self):\n \"\"\"Return the unique id of the sensor.\"\"\"\n if self._serial_number:\n return self._serial_number\n if self._device_serial_number:\n return f\"{self._device_serial_number}_{self.entity_description.key}\"\n\n @property\n def device_info(self) -> DeviceInfo or None:\n \"\"\"Return the device_info of the device.\"\"\"\n if not self._device_serial_number:\n return None\n return DeviceInfo(\n identifiers={(DOMAIN, str(self._device_serial_number))},\n manufacturer=\"Enphase\",\n model=\"Envoy\",\n name=self._device_name,\n )\n\n @property\n def is_on(self) -> bool:\n \"\"\"Return the status of the requested attribute.\"\"\"\n return self.coordinator.data.get(\"grid_status\") == \"closed\"\n" }, { "path": "custom_components/enphase_envoy_custom/config_flow.py", "content": "\"\"\"Config flow for Enphase Envoy integration.\"\"\"\nfrom __future__ import annotations\n\nimport contextlib\nimport logging\nfrom typing import Any\n\nfrom .envoy_reader import EnvoyReader\nimport httpx\nimport voluptuous as vol\n\nfrom homeassistant import config_entries\nfrom homeassistant.components import network\nfrom homeassistant.components import zeroconf\nfrom homeassistant.const import CONF_HOST, CONF_NAME, CONF_PASSWORD, CONF_USERNAME\nfrom homeassistant.core import HomeAssistant, callback\nfrom homeassistant.data_entry_flow import FlowResult\nfrom homeassistant.exceptions import HomeAssistantError\nfrom homeassistant.util.network import is_ipv4_address\n\nfrom .const import DOMAIN, CONF_SERIAL, CONF_USE_ENLIGHTEN, DEFAULT_SCAN_INTERVAL\n\n_LOGGER = logging.getLogger(__name__)\n\nENVOY = \"Envoy\"\n\n\nasync def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> EnvoyReader:\n \"\"\"Validate the user input allows us to connect.\"\"\"\n envoy_reader = EnvoyReader(\n data[CONF_HOST],\n username=data[CONF_USERNAME],\n password=data[CONF_PASSWORD],\n enlighten_user=data[CONF_USERNAME],\n enlighten_pass=data[CONF_PASSWORD],\n inverters=False,\n# async_client=get_async_client(hass),\n use_enlighten_owner_token=data.get(CONF_USE_ENLIGHTEN, False),\n enlighten_serial_num=data[CONF_SERIAL],\n https_flag='s' if data.get(CONF_USE_ENLIGHTEN,False) else '',\n fetch_timeout_seconds=60\n )\n\n try:\n await envoy_reader.getData()\n except httpx.HTTPStatusError as err:\n _LOGGER.warning(\"Validate input, getdata returned HTTPStatusError: %s\",err)\n raise InvalidAuth from err\n except (httpx.HTTPError) as err:\n _LOGGER.warning(\"Validate input, getdata returned HTTPError: %s\",err)\n raise CannotConnect from err\n except (RuntimeError) as err:\n _LOGGER.warning(\"Validate input, getdata returned RuntimeError: %s\",err)\n raise\n\n return envoy_reader\n\nasync def ipv4asdefault(hass: HomeAssistant):\n adapters = await network.async_get_adapters(hass)\n for adapter in adapters:\n if adapter[\"default\"]:\n return adapter[\"ipv4\"] is not None\n return False\n\nclass ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):\n \"\"\"Handle a config flow for Enphase Envoy.\"\"\"\n\n VERSION = 1\n\n def __init__(self):\n \"\"\"Initialize an envoy flow.\"\"\"\n self.ip_address = None\n self.username = None\n self._reauth_entry = None\n\n @callback\n def _async_generate_schema(self):\n \"\"\"Generate schema.\"\"\"\n schema = {}\n\n if self.ip_address:\n schema[vol.Required(CONF_HOST, default=self.ip_address)] = vol.In(\n [self.ip_address]\n )\n else:\n schema[vol.Required(CONF_HOST)] = str\n\n schema[vol.Optional(CONF_USERNAME, default=self.username)] = str\n schema[vol.Optional(CONF_PASSWORD, default=\"\")] = str\n schema[vol.Optional(CONF_SERIAL, default=self.unique_id)] = str\n schema[vol.Optional(CONF_USE_ENLIGHTEN)] = bool\n return vol.Schema(schema)\n\n @callback\n def _async_current_hosts(self):\n \"\"\"Return a set of hosts.\"\"\"\n return {\n entry.data[CONF_HOST]\n for entry in self._async_current_entries(include_ignore=False)\n if CONF_HOST in entry.data\n }\n\n async def async_step_zeroconf(\n self, discovery_info: zeroconf.ZeroconfServiceInfo\n ) -> FlowResult:\n \"\"\"Handle a flow initialized by zeroconf discovery.\"\"\"\n serial = discovery_info.properties[\"serialnum\"]\n await self.async_set_unique_id(serial)\n\n ipv4_default = await ipv4asdefault(self.hass)\n\n if ipv4_default and not is_ipv4_address(discovery_info.host):\n return self.async_abort(reason=\"not_ipv4_address\")\n \n # autodiscovery is updating the ip address of an existing envoy with matching serial to new detected ip adress\n self.ip_address = discovery_info.host\n self._abort_if_unique_id_configured({CONF_HOST: self.ip_address})\n for entry in self._async_current_entries(include_ignore=False):\n if (\n entry.unique_id is None\n and CONF_HOST in entry.data\n and entry.data[CONF_HOST] == self.ip_address\n ):\n title = f\"{ENVOY} {serial}\" if entry.title == ENVOY else ENVOY\n self.hass.config_entries.async_update_entry(\n entry, title=title, unique_id=serial\n )\n self.hass.async_create_task(\n self.hass.config_entries.async_reload(entry.entry_id)\n )\n return self.async_abort(reason=\"already_configured\")\n\n return await self.async_step_user()\n\n async def async_step_reauth(self, user_input):\n \"\"\"Handle configuration by re-auth.\"\"\"\n self._reauth_entry = self.hass.config_entries.async_get_entry(\n self.context[\"entry_id\"]\n )\n return await self.async_step_user()\n\n def _async_envoy_name(self) -> str:\n \"\"\"Return the name of the envoy.\"\"\"\n if self.unique_id:\n return f\"{ENVOY} {self.unique_id}\"\n return ENVOY\n\n async def _async_set_unique_id_from_envoy(self, envoy_reader: EnvoyReader) -> bool:\n \"\"\"Set the unique id by fetching it from the envoy.\"\"\"\n serial = None\n with contextlib.suppress(httpx.HTTPError):\n serial = await envoy_reader.get_full_serial_number()\n if serial:\n await self.async_set_unique_id(serial)\n return True\n return False\n\n async def async_step_user(\n self, user_input: dict[str, Any] | None = None\n ) -> FlowResult:\n \"\"\"Handle the initial step.\"\"\"\n errors = {}\n\n if user_input is not None:\n if (\n not self._reauth_entry\n and user_input[CONF_HOST] in self._async_current_hosts()\n ):\n return self.async_abort(reason=\"already_configured\")\n try:\n envoy_reader = await validate_input(self.hass, user_input)\n except RuntimeError as rerr:\n errors[\"base\"] = \"invalid_auth\"\n except CannotConnect as cerr:\n errors[\"base\"] = \"cannot_connect\"\n except InvalidAuth:\n errors[\"base\"] = \"invalid_auth\"\n except Exception as exc: # pylint: disable=broad-except\n _LOGGER.exception(\"Unexpected exception in validate input %s\",exc)\n errors[\"base\"] = \"unknown\"\n else:\n data = user_input.copy()\n data[CONF_NAME] = self._async_envoy_name()\n\n if self._reauth_entry:\n self.hass.config_entries.async_update_entry(\n self._reauth_entry,\n data=data,\n )\n return self.async_abort(reason=\"reauth_successful\")\n\n if not self.unique_id and await self._async_set_unique_id_from_envoy(\n envoy_reader\n ):\n data[CONF_NAME] = self._async_envoy_name()\n\n if self.unique_id:\n self._abort_if_unique_id_configured({CONF_HOST: data[CONF_HOST]})\n\n return self.async_create_entry(title=data[CONF_NAME], data=data)\n\n if self.unique_id:\n self.context[\"title_placeholders\"] = {\n CONF_SERIAL: self.unique_id,\n CONF_HOST: self.ip_address,\n }\n return self.async_show_form(\n step_id=\"user\",\n data_schema=self._async_generate_schema(),\n errors=errors,\n )\n\n @staticmethod\n @callback\n def async_get_options_flow(config_entry):\n return EnvoyOptionsFlowHandler(config_entry)\n\nclass EnvoyOptionsFlowHandler(config_entries.OptionsFlow):\n \"\"\"Envoy config flow options handler.\"\"\"\n\n def __init__(self, config_entry):\n \"\"\"Initialize Envoy options flow.\"\"\"\n self.config_entry = config_entry\n\n async def async_step_init(self, _user_input=None):\n \"\"\"Manage the options.\"\"\"\n return await self.async_step_user()\n\n async def async_step_user(self, user_input=None):\n \"\"\"Handle a flow initialized by the user.\"\"\"\n\n if user_input is not None:\n return self.async_create_entry(title=\"\", data=user_input)\n\n schema = {\n vol.Optional(\n \"data_interval\",\n default=self.config_entry.options.get(\n \"data_interval\", DEFAULT_SCAN_INTERVAL\n ),\n ): vol.All(vol.Coerce(int), vol.Range(min=5)),\n vol.Optional(\n \"data_fetch_timeout_seconds\",\n default=self.config_entry.options.get(\n \"data_fetch_timeout_seconds\", 30\n ),\n ): vol.All(vol.Coerce(int), vol.Range(min=5)),\n vol.Optional(\n \"data_fetch_retry_count\",\n default=self.config_entry.options.get(\n \"data_fetch_retry_count\", 1\n ),\n ): vol.All(vol.Coerce(int), vol.Range(min=1)),\n vol.Optional(\n \"data_fetch_holdoff_seconds\",\n default=self.config_entry.options.get(\n \"data_fetch_holdoff_seconds\", 0\n ),\n ): vol.All(vol.Coerce(int), vol.Range(min=0)),\n vol.Optional(\n \"data_collection_timeout_seconds\",\n default=self.config_entry.options.get(\n \"data_collection_timeout_seconds\", 55\n ),\n ): vol.All(vol.Coerce(int), vol.Range(min=30)),\n vol.Optional(\n \"do_not_use_production_json\",\n default=self.config_entry.options.get(\n \"do_not_use_production_json\", False\n ),\n ): bool,\n }\n return self.async_show_form(step_id=\"user\", data_schema=vol.Schema(schema))\n\nclass CannotConnect(HomeAssistantError):\n \"\"\"Error to indicate we cannot connect.\"\"\"\n\n\nclass InvalidAuth(HomeAssistantError):\n \"\"\"Error to indicate there is invalid auth.\"\"\"\n" }, { "path": "custom_components/enphase_envoy_custom/const.py", "content": "\"\"\"The enphase_envoy component.\"\"\"\n\nfrom homeassistant.components.binary_sensor import (\n BinarySensorDeviceClass,\n BinarySensorEntityDescription\n)\n\nfrom homeassistant.components.sensor import (\n SensorDeviceClass,\n SensorEntityDescription,\n SensorStateClass\n\n)\nfrom homeassistant.const import (\n UnitOfEnergy, \n UnitOfPower, \n UnitOfElectricPotential,\n UnitOfFrequency,\n Platform, \n PERCENTAGE\n)\n\nDOMAIN = \"enphase_envoy\"\n\nPLATFORMS = [Platform.SENSOR, Platform.BINARY_SENSOR]\n\nICON = \"mdi:flash\"\n\nCOORDINATOR = \"coordinator\"\nNAME = \"name\"\n\nDEFAULT_SCAN_INTERVAL = 60 # default in seconds\n\nCONF_SERIAL = \"serial\"\nCONF_USE_ENLIGHTEN = \"use_enlighten\"\n\nSENSORS = (\n SensorEntityDescription(\n key=\"production\",\n name=\"Current Power Production\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_production\",\n name=\"Today's Energy Production\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"seven_days_production\",\n name=\"Last Seven Days Energy Production\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_production\",\n name=\"Lifetime Energy Production\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_net_production\",\n name=\"Lifetime Net Energy Production\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"consumption\",\n name=\"Current Power Consumption\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"net_consumption\",\n name=\"Current Net Power Consumption\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_consumption\",\n name=\"Today's Energy Consumption\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"seven_days_consumption\",\n name=\"Last Seven Days Energy Consumption\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_consumption\",\n name=\"Lifetime Energy Consumption\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_net_consumption\",\n name=\"Lifetime Net Energy Consumption\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"inverters\",\n name=\"Inverter\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"batteries\",\n name=\"Battery\",\n native_unit_of_measurement=PERCENTAGE,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.BATTERY\n ),\n SensorEntityDescription(\n key=\"total_battery_percentage\",\n name=\"Total Battery Percentage\",\n native_unit_of_measurement=PERCENTAGE,\n state_class=SensorStateClass.MEASUREMENT\n ),\n SensorEntityDescription(\n key=\"current_battery_capacity\",\n name=\"Current Battery Capacity\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL,\n device_class=SensorDeviceClass.ENERGY\n ),\n SensorEntityDescription(\n key=\"pf\",\n name=\"Power Factor\",\n device_class=SensorDeviceClass.POWER_FACTOR,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"voltage\",\n name=\"Voltage\",\n native_unit_of_measurement=UnitOfElectricPotential.VOLT,\n device_class=SensorDeviceClass.VOLTAGE,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"frequency\",\n name=\"Frequency\",\n native_unit_of_measurement=UnitOfFrequency.HERTZ,\n device_class=SensorDeviceClass.FREQUENCY,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"consumption_Current\",\n name=\"Consumption Current\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"production_Current\",\n name=\"Production Current\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"active_inverter_count\",\n name=\"Active Inverter Count\",\n state_class=SensorStateClass.MEASUREMENT,\n entity_registry_enabled_default=False,\n ),\n\n)\n\nBINARY_SENSORS = (\n BinarySensorEntityDescription(\n key=\"grid_status\",\n name=\"Grid Status\",\n device_class=BinarySensorDeviceClass.CONNECTIVITY,\n ),\n)\n\nPHASE_SENSORS = (\n SensorEntityDescription(\n key=\"production_l1\",\n name=\"Current Power Production L1\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_production_l1\",\n name=\"Today's Energy Production L1\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_production_l1\",\n name=\"Lifetime Energy Production L1\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_net_production_l1\",\n name=\"Lifetime Net Energy Production L1\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"production_l2\",\n name=\"Current Power Production L2\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_production_l2\",\n name=\"Today's Energy Production L2\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_production_l2\",\n name=\"Lifetime Energy Production L2\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_net_production_l2\",\n name=\"Lifetime Net Energy Production L2\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"production_l3\",\n name=\"Current Power Production L3\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_production_l3\",\n name=\"Today's Energy Production L3\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_production_l3\",\n name=\"Lifetime Energy Production L3\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_net_production_l3\",\n name=\"Lifetime Net Energy Production L3\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"consumption_l1\",\n name=\"Current Power Consumption L1\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"net_consumption_l1\",\n name=\"Current Net Power Consumption L1\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_consumption_l1\",\n name=\"Today's Energy Consumption L1\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_consumption_l1\",\n name=\"Lifetime Energy Consumption L1\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_net_consumption_l1\",\n name=\"Lifetime Net Energy Consumption L1\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"consumption_l2\",\n name=\"Current Power Consumption L2\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"net_consumption_l2\",\n name=\"Current Net Power Consumption L2\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_consumption_l2\",\n name=\"Today's Energy Consumption L2\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_consumption_l2\",\n name=\"Lifetime Energy Consumption L2\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_net_consumption_l2\",\n name=\"Lifetime Net Energy Consumption L2\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"consumption_l3\",\n name=\"Current Power Consumption L3\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"net_consumption_l3\",\n name=\"Current Net Power Consumption L3\",\n native_unit_of_measurement=UnitOfPower.WATT,\n state_class=SensorStateClass.MEASUREMENT,\n device_class=SensorDeviceClass.POWER,\n ),\n SensorEntityDescription(\n key=\"daily_consumption_l3\",\n name=\"Today's Energy Consumption L3\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"lifetime_consumption_l3\",\n name=\"Lifetime Energy Consumption L3\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n \n SensorEntityDescription(\n key=\"lifetime_net_consumption_l3\",\n name=\"Lifetime Net Energy Consumption L3\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL_INCREASING,\n device_class=SensorDeviceClass.ENERGY,\n ),\n SensorEntityDescription(\n key=\"pf_l1\",\n name=\"Power Factor L1\",\n device_class=SensorDeviceClass.POWER_FACTOR,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"pf_l2\",\n name=\"Power Factor L2\",\n device_class=SensorDeviceClass.POWER_FACTOR,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"pf_l3\",\n name=\"Power Factor L3\",\n device_class=SensorDeviceClass.POWER_FACTOR,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"voltage_l1\",\n name=\"Voltage L1\",\n native_unit_of_measurement=UnitOfElectricPotential.VOLT,\n device_class=SensorDeviceClass.VOLTAGE,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"voltage_l2\",\n name=\"Voltage L2\",\n native_unit_of_measurement=UnitOfElectricPotential.VOLT,\n device_class=SensorDeviceClass.VOLTAGE,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"voltage_l3\",\n name=\"Voltage L3\",\n native_unit_of_measurement=UnitOfElectricPotential.VOLT,\n device_class=SensorDeviceClass.VOLTAGE,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"frequency_l1\",\n name=\"Frequency L1\",\n native_unit_of_measurement=UnitOfFrequency.HERTZ,\n device_class=SensorDeviceClass.FREQUENCY,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"frequency_l2\",\n name=\"Frequency L2\",\n native_unit_of_measurement=UnitOfFrequency.HERTZ,\n device_class=SensorDeviceClass.FREQUENCY,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"frequency_l3\",\n name=\"Frequency L3\",\n native_unit_of_measurement=UnitOfFrequency.HERTZ,\n device_class=SensorDeviceClass.FREQUENCY,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"consumption_Current_l1\",\n name=\"Consumption Current L1\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"consumption_Current_l2\",\n name=\"Consumption Current L2\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"consumption_Current_l3\",\n name=\"Consumption Current L3\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"production_Current_l1\",\n name=\"Production Current L1\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"production_Current_l2\",\n name=\"Production Current L2\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n SensorEntityDescription(\n key=\"production_Current_l3\",\n name=\"Production Current L3\",\n native_unit_of_measurement=\"A\",\n device_class=SensorDeviceClass.CURRENT,\n entity_registry_enabled_default=False,\n ),\n\n)\n\nBATTERY_ENERGY_DISCHARGED_SENSOR = SensorEntityDescription(\n key=\"battery_energy_discharged\",\n name=\"Battery Energy Discharged\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL,\n device_class=SensorDeviceClass.ENERGY\n)\n\nBATTERY_ENERGY_CHARGED_SENSOR = SensorEntityDescription(\n key=\"battery_energy_charged\",\n name=\"Battery Energy Charged\",\n native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,\n state_class=SensorStateClass.TOTAL,\n device_class=SensorDeviceClass.ENERGY\n)\n" }, { "path": "custom_components/enphase_envoy_custom/diagnostics.py", "content": "\"\"\"Diagnostics support for Enphase Envoy.\"\"\"\nfrom __future__ import annotations\n\nfrom typing import Any\n\nfrom attr import asdict\n\nfrom homeassistant.components.diagnostics import async_redact_data\nfrom homeassistant.config_entries import ConfigEntry\nfrom homeassistant.const import CONF_PASSWORD, CONF_USERNAME\nfrom homeassistant.core import HomeAssistant\nfrom homeassistant.helpers import device_registry as dr, entity_registry as er\nfrom homeassistant.helpers.update_coordinator import DataUpdateCoordinator\n\nfrom .const import COORDINATOR, DOMAIN\n\nCONF_TITLE = \"title\"\n\nTO_REDACT = {\n # CONF_NAME,\n CONF_PASSWORD,\n # Config entry title and unique ID may contain sensitive data:\n # CONF_TITLE,\n # CONF_UNIQUE_ID,\n CONF_USERNAME,\n}\n\n\nasync def async_get_config_entry_diagnostics(\n hass: HomeAssistant, entry: ConfigEntry\n) -> dict[str, Any]:\n \"\"\"Return diagnostics for a config entry.\"\"\"\n coordinator: DataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id][COORDINATOR]\n\n device_registry = dr.async_get(hass)\n entity_registry = er.async_get(hass)\n\n devices = []\n\n registry_devices = dr.async_entries_for_config_entry(\n device_registry, entry.entry_id\n )\n\n for device in registry_devices:\n entities = []\n\n registry_entities = er.async_entries_for_device(\n entity_registry,\n device_id=device.id,\n include_disabled_entities=True,\n )\n\n for entity in registry_entities:\n state_dict = None\n if state := hass.states.get(entity.entity_id):\n state_dict = dict(state.as_dict())\n state_dict.pop(\"context\", None)\n\n entities.append({\"entry\": asdict(entity), \"state\": state_dict})\n\n devices.append({\"device\": asdict(device), \"entities\": entities})\n\n return async_redact_data(\n {\n \"entry\": entry.as_dict(),\n \"data\": coordinator.data,\n \"Note\": \"Entities that show as null are not available for your Envoy\",\n \"devices\": devices,\n },\n TO_REDACT,\n )\n" }, { "path": "custom_components/enphase_envoy_custom/envoy_reader.py", "content": "\"\"\"Module to read production and consumption values from an Enphase Envoy on the local network.\"\"\"\nimport argparse\nimport datetime\nimport logging\nimport time\nfrom json.decoder import JSONDecodeError\nimport json\nfrom ipaddress import IPv4Address, IPv6Address\nimport sys\nimport getpass\n\n#Modules not in standard Python Library - add to manifest requirements\nimport re\nimport jwt\nimport asyncio\nimport httpx\nimport xmltodict\nfrom envoy_utils.envoy_utils import EnvoyUtils\n\n#\n# Legacy parser is only used on ancient firmwares\n#\nPRODUCTION_REGEX = r\"Currentl.*\\s+\\s*(\\d+|\\d+\\.\\d+)\\s*(W|kW|MW)\"\nDAY_PRODUCTION_REGEX = r\"Today\\s+\\s*(\\d+|\\d+\\.\\d+)\\s*(Wh|kWh|MWh)\"\nWEEK_PRODUCTION_REGEX = (\n r\"Past Week\\s+\\s*(\\d+|\\d+\\.\\d+)\\s*(Wh|kWh|MWh)\"\n)\nLIFE_PRODUCTION_REGEX = (\n r\"Since Installation\\s+\\s*(\\d+|\\d+\\.\\d+)\\s*(Wh|kWh|MWh)\"\n)\nSERIAL_REGEX = re.compile(r\"Envoy\\s*Serial\\s*Number:\\s*([0-9]+)\")\nACTIVE_INVERTER_COUNT_REGEX = r\"Number of Microinverters Online\\s*\\s*(\\d*)\\s*\"\n\nENDPOINT_URL_PRODUCTION_JSON = \"http{}://{}/production.json?details=1\"\nENDPOINT_URL_PRODUCTION_V1 = \"http{}://{}/api/v1/production\"\nENDPOINT_URL_PRODUCTION_INVERTERS = \"http{}://{}/api/v1/production/inverters\"\nENDPOINT_URL_PRODUCTION = \"http{}://{}/production\"\nENDPOINT_URL_CHECK_JWT = \"https://{}/auth/check_jwt\"\nENDPOINT_URL_ENSEMBLE_INVENTORY = \"http{}://{}/ivp/ensemble/inventory\"\nENDPOINT_URL_HOME_JSON = \"http{}://{}/home.json\"\nENDPOINT_URL_HOME = \"http{}://{}/home\"\nENDPOINT_URL_INFO_XML = \"http{}://{}/info\"\nENDPOINT_URL_METERS = \"http{}://{}/ivp/meters\"\nENDPOINT_URL_METERS_REPORTS = \"http{}://{}/ivp/meters/reports\"\nENDPOINT_URL_METERS_READINGS = \"http{}://{}/ivp/meters/readings\"\n\n# pylint: disable=pointless-string-statement\n\nENVOY_MODEL_S = \"PC\"\nENVOY_MODEL_C = \"P\"\nENVOY_MODEL_LEGACY = \"P0\"\n\nLOGIN_URL = \"https://entrez.enphaseenergy.com/login_main_page\"\nTOKEN_URL = \"https://entrez.enphaseenergy.com/entrez_tokens\"\n\n# paths for the enlighten 1 year owner token\nENLIGHTEN_AUTH_URL = \"https://enlighten.enphaseenergy.com/login/login.json\"\nENLIGHTEN_TOKEN_URL = \"https://entrez.enphaseenergy.com/tokens\"\n\n_LOGGER = logging.getLogger(__name__)\n\n\ndef has_production_and_consumption(json):\n \"\"\"Check if json has keys for both production and consumption.\"\"\"\n return \"production\" in json and \"consumption\" in json\n\n\ndef has_metering_setup(json):\n \"\"\"Check if Active Count of Production CTs (eim) installed is greater than one.\"\"\"\n return json[\"production\"][1][\"activeCount\"] > 0\n\n\ndef has_production_metering_setup(json):\n \"\"\"Check if Production CTs (eim) are installed.\"\"\"\n return json[0][\"state\"] == \"enabled\"\n\n\ndef has_consumption_metering_setup(json):\n \"\"\"Check if Consumption CTs (eim) are installed.\"\"\"\n return json[1][\"state\"] == \"enabled\"\n\n\ndef has_net_consumption_meters_type(json):\n \"\"\"Check if Consumption measurement type is net-consumption.\"\"\"\n return json[1][\"measurementType\"] == \"net-consumption\"\n\n\ndef get_production_meters_phase_count(json):\n \"\"\"Get Count of Production CTs (eim) installed.\"\"\"\n return json[0][\"phaseCount\"]\n\n\ndef get_consumption_meters_phase_count(json):\n \"\"\"Get Count of Consumption CTs (eim) installed.\"\"\"\n return json[1][\"phaseCount\"]\n\n \ndef is_ipv6_address(address: str) -> bool:\n \"\"\"Check if a given string is an IPv6 address.\"\"\"\n try:\n IPv6Address(address)\n except ValueError:\n return False\n return True\n\nclass SwitchToHTTPS(Exception):\n pass\n\n\nclass EnvoyReader: # pylint: disable=too-many-instance-attributes\n \"\"\"Instance of EnvoyReader\"\"\"\n\n # P0 for older Envoy model C, s/w < R3.9 no json pages\n # P for production data only (ie. Envoy model C, s/w >= R3.9)\n # PC for production and consumption data (ie. Envoy model S)\n\n message_battery_not_available = (\n \"Battery storage data not available for your Envoy device.\"\n )\n\n message_production_not_available = (\n \"CTs production data not available for your Envoy device.\"\n )\n\n message_consumption_not_available = (\n \"CTs consumption data not available for your Envoy device.\"\n )\n\n message_grid_status_not_available = (\n \"Grid status not available for your Envoy device.\"\n )\n\n message_frequency_not_available = (\n \"Frequency data not available for your Envoy device.\"\n )\n\n message_voltage_not_available = (\n \"Voltage data not available for your Envoy device.\"\n )\n message_pf_not_available = (\n \"Power Factor data not available for your Envoy device.\"\n )\n message_current_consumption_not_available = (\n \"Amps consumption data not available for your Envoy device.\"\n )\n message_current_production_not_available = (\n \"Amps production data not available for your Envoy device.\"\n )\n\n message_active_inverters_not_available = (\n \"Active Inverter count not available for your Envoy device.\"\n )\n\n\n def __init__( # pylint: disable=too-many-arguments\n self,\n host,\n username=\"envoy\",\n password=\"\",\n inverters=False,\n async_client=None,\n enlighten_user=None,\n enlighten_pass=None,\n commissioned=False,\n enlighten_site_id=None,\n enlighten_serial_num=None,\n https_flag=\"\",\n use_enlighten_owner_token=False,\n token_refresh_buffer_seconds=0,\n store=None,\n info_refresh_buffer_seconds=3600,\n fetch_timeout_seconds=30,\n fetch_holdoff_seconds=0,\n fetch_retries=1,\n do_not_use_production_json=False,\n ):\n \"\"\"Init the EnvoyReader.\"\"\"\n self.host = host.lower().replace('[','').replace(']','')\n # IPv6 addresses need to be enclosed in brackets\n if is_ipv6_address(self.host):\n self.host = f\"[{self.host}]\"\n self.username = username\n self.password = password\n self.get_inverters = inverters\n self.endpoint_type = None\n self.has_grid_status = True\n self.serial_number_last_six = None\n self.endpoint_meters_reports_json_results = None\n self.endpoint_meters_readings_json_results = None\n self.endpoint_production_json_results = None\n self.endpoint_production_v1_results = None\n self.endpoint_production_inverters = None\n self.endpoint_production_results = None\n self.endpoint_ensemble_json_results = None\n self.endpoint_home_json_results = None\n self.endpoint_home_results = None\n self.isProductionMeteringEnabled = False # pylint: disable=invalid-name\n self.isConsumptionMeteringEnabled = False # pylint: disable=invalid-name\n self.net_consumption_meters_type = False\n self.production_meters_phase_count = 0\n self.consumption_meters_phase_count = 0\n self._async_client = async_client\n self._authorization_header = None\n self._cookies = None\n self.enlighten_user = enlighten_user\n self.enlighten_pass = enlighten_pass\n self.commissioned = commissioned\n self.enlighten_site_id = enlighten_site_id\n self.enlighten_serial_num = enlighten_serial_num\n self.https_flag = https_flag\n self.use_enlighten_owner_token = use_enlighten_owner_token\n self.token_refresh_buffer_seconds = token_refresh_buffer_seconds\n self.endpoint_info_results = None\n self.endpoint_meters_json_results = None\n self.info_refresh_buffer_seconds = info_refresh_buffer_seconds\n self.info_next_refresh_time = datetime.datetime.now()\n self.meters_next_refresh_time = datetime.datetime.now()\n self._store = store\n self._store_data = {}\n self._store_update_pending = False\n self._fetch_timeout_seconds = fetch_timeout_seconds\n self._fetch_holdoff_seconds = fetch_holdoff_seconds\n self._fetch_retries = max(fetch_retries,1)\n self._do_not_use_production_json=do_not_use_production_json\n\n @property\n def _token(self):\n return self._store_data.get(\"token\", \"\")\n\n @_token.setter\n def _token(self, token_value):\n self._store_data[\"token\"] = token_value\n self._store_update_pending = True\n\n async def _sync_store(self):\n if self._store and not self._store_data:\n self._store_data = await self._store.async_load() or {}\n\n if self._store and self._store_update_pending:\n self._store_update_pending = False\n await self._store.async_save(self._store_data)\n\n @property\n def async_client(self):\n \"\"\"Return the httpx client.\"\"\"\n return self._async_client or httpx.AsyncClient(verify=False,\n headers=self._authorization_header,\n cookies=self._cookies)\n\n @property\n def non_local_async_client(self):\n \"\"\"Return the httpx client for non-local usage.\"\"\"\n return self._async_client or httpx.AsyncClient(verify=True,\n headers=self._authorization_header,\n cookies=self._cookies)\n\n async def _update(self):\n \"\"\"Update the data.\"\"\"\n _LOGGER.debug(\"_update running\")\n if self.endpoint_type == ENVOY_MODEL_S:\n await self._update_meters_endpoint()\n await self._update_from_pc_endpoint()\n if self.endpoint_type == ENVOY_MODEL_C or (\n self.endpoint_type == ENVOY_MODEL_S and not self.isProductionMeteringEnabled\n ):\n await self._update_from_p_endpoint()\n if self.endpoint_type == ENVOY_MODEL_LEGACY:\n await self._update_from_p0_endpoint()\n \n await self._update_info_endpoint()\n\n async def _update_from_meters_reports_endpoint(self):\n \"\"\"Update from ivp/meters endpoint.\"\"\"\n if self.endpoint_type == ENVOY_MODEL_S:\n #only touch meters reports if confirmed envoy model S, other type choke up on this request\n await self._update_endpoint(\n \"endpoint_meters_reports_json_results\", ENDPOINT_URL_METERS_REPORTS\n )\n\n async def _update_from_meters_readings_endpoint(self):\n \"\"\"Update from ivp/meters/readings endpoint.\"\"\"\n if self.endpoint_type == ENVOY_MODEL_S:\n #only touch meters reports if confirmed envoy model S, other type choke up on this request\n await self._update_endpoint(\n \"endpoint_meters_readings_json_results\", ENDPOINT_URL_METERS_READINGS\n )\n\n async def _update_from_pc_endpoint(self,detectmode=False):\n \"\"\"Update from PC endpoint.\"\"\"\n if not self._do_not_use_production_json or detectmode:\n await self._update_endpoint(\n \"endpoint_production_json_results\", ENDPOINT_URL_PRODUCTION_JSON\n )\n await self._update_endpoint(\n \"endpoint_ensemble_json_results\", ENDPOINT_URL_ENSEMBLE_INVENTORY\n )\n if self.has_grid_status:\n await self._update_endpoint(\n \"endpoint_home_json_results\", ENDPOINT_URL_HOME_JSON\n )\n\n async def _update_from_p_endpoint(self):\n \"\"\"Update from P endpoint.\"\"\"\n await self._update_endpoint(\n \"endpoint_production_v1_results\", ENDPOINT_URL_PRODUCTION_V1\n )\n\n async def _update_from_p0_endpoint(self):\n \"\"\"Update from P0 endpoint.\"\"\"\n await self._update_endpoint(\n \"endpoint_production_results\", ENDPOINT_URL_PRODUCTION\n )\n await self._update_endpoint(\n \"endpoint_home_results\", ENDPOINT_URL_HOME\n )\n\n async def _update_info_endpoint(self):\n \"\"\"Update from info endpoint if next time expired.\"\"\"\n if self.info_next_refresh_time <= datetime.datetime.now():\n await self._update_endpoint(\"endpoint_info_results\", ENDPOINT_URL_INFO_XML)\n self.info_next_refresh_time = datetime.datetime.now() + datetime.timedelta(\n seconds=self.info_refresh_buffer_seconds\n )\n _LOGGER.debug(\n \"Info endpoint updated, set next update time: %s using interval: %s\",\n self.info_next_refresh_time,\n self.info_refresh_buffer_seconds,\n )\n else:\n _LOGGER.debug(\n \"Info endpoint next update time is: %s using interval: %s\",\n self.info_next_refresh_time,\n self.info_refresh_buffer_seconds,\n )\n\n async def _update_meters_endpoint(self):\n \"\"\"Update from meters endpoint if next time expried.\"\"\"\n if self.meters_next_refresh_time <= datetime.datetime.now():\n await self._update_endpoint(\"endpoint_meters_json_results\", ENDPOINT_URL_METERS)\n\n #some devices return [] for ivp/meters\n if self.endpoint_meters_json_results and self.endpoint_meters_json_results.text != \"[]\":\n\n self.isProductionMeteringEnabled = has_production_metering_setup(\n self.endpoint_meters_json_results.json()\n )\n self.isConsumptionMeteringEnabled = has_consumption_metering_setup(\n self.endpoint_meters_json_results.json()\n )\n self.net_consumption_meters_type = has_net_consumption_meters_type(\n self.endpoint_meters_json_results.json()\n )\n self.production_meters_phase_count = get_production_meters_phase_count(\n self.endpoint_meters_json_results.json()\n )\n self.consumption_meters_phase_count = get_consumption_meters_phase_count(\n self.endpoint_meters_json_results.json()\n )\n self.meters_next_refresh_time = datetime.datetime.now() + datetime.timedelta(\n seconds=self.info_refresh_buffer_seconds\n )\n\n _LOGGER.debug(\n \"Meters endpoint updated, set next update time: %s using interval: %s\",\n self.meters_next_refresh_time,\n self.info_refresh_buffer_seconds,\n )\n else:\n _LOGGER.debug(\n \"Meters endpoint next update time is: %s using interval: %s\",\n self.meters_next_refresh_time,\n self.info_refresh_buffer_seconds,\n )\n await self._update_from_meters_reports_endpoint()\n await self._update_from_meters_readings_endpoint()\n\n async def _update_endpoint(self, attr, url):\n \"\"\"Update a property from an endpoint.\"\"\"\n formatted_url = url.format(self.https_flag, self.host)\n response = await self._async_fetch_with_retry(\n formatted_url, follow_redirects=False\n )\n setattr(self, attr, response)\n\n async def _async_fetch_with_retry(self, url, **kwargs):\n \"\"\"Retry 3 times to fetch the url if there is a transport error.\"\"\"\n for attempt in range(self._fetch_retries + 1):\n header = \" \"\n if self._authorization_header:\n header = \"