Solaredge new sensors (#21047)
* Remove unused hass parameter for SolarEdgeData * Add factory to create different types of sensors Rename SolarEdgeSensor to SolarEdgeOverviewSensor Rename SolarEdgeData to SolarEdgeOverviewDataService Remove unused hass parameter in SolarEdgeOverviewDataService * Add SolarEdgeDetailsDataService to retrieve details data Add SolarEdgeDetailsSensor to report details data Add abstract class SolarEdgeSensor Add details sensor types * Combine multiple details sensor into one sensor with attributes * Fix pylint and flake8 errors * Resolve conflict with solaredge component update * Add SolarEdgeInventoryDataService to retrieve inventory information Add SolarEdgeInventorySensor to view inventory information Add inverters to monitored_conditions * Fix pylint and flake8 errors * Add additional monitored variables for solaredge * Add new sensors to solaredge component * Add SolarEdgePowerFlowDataService Add SolarEdgePowerFlowSensor Add new monitored_conditions for power consumption and grid, load and solar power production/consumption * Set entity_id for each sensor based on platform and sensor type * Fix flake8 and pylint errors * Add check for connections in return data * Fix pylint and flake8 errors * Renamed state_attributes to device_state_attributes Moved request import to top * Remove explicit definition of entity_id * Fix pylint and flake8 errors * Add check for None before adding sensor * Update SolarEdgeSensorFactory with initial dict which maps sensor_key to entity class and data service * Update attribute values to snakecase Added stingcase as requirement * Update requirements_all.txt to include stringcase for solaredge * Update some initial values for data and unit_of_measurement Update sensor factorypull/22484/head
Gido
Charles Garwood
parent
2b48ecd5c5
commit
24c7c2aa6e
|
|
@ -10,6 +10,7 @@ import logging
|
|||
|
||||
import voluptuous as vol
|
||||
|
||||
from requests.exceptions import HTTPError, ConnectTimeout
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
from homeassistant.const import (
|
||||
CONF_API_KEY, CONF_MONITORED_CONDITIONS, CONF_NAME, POWER_WATT,
|
||||
|
|
@ -18,15 +19,19 @@ import homeassistant.helpers.config_validation as cv
|
|||
from homeassistant.helpers.entity import Entity
|
||||
from homeassistant.util import Throttle
|
||||
|
||||
REQUIREMENTS = ['solaredge==0.0.2']
|
||||
REQUIREMENTS = ['solaredge==0.0.2', 'stringcase==1.2.0']
|
||||
|
||||
# Config for solaredge monitoring api requests.
|
||||
CONF_SITE_ID = "site_id"
|
||||
|
||||
UPDATE_DELAY = timedelta(minutes=10)
|
||||
OVERVIEW_UPDATE_DELAY = timedelta(minutes=10)
|
||||
DETAILS_UPDATE_DELAY = timedelta(hours=12)
|
||||
INVENTORY_UPDATE_DELAY = timedelta(hours=12)
|
||||
POWER_FLOW_UPDATE_DELAY = timedelta(minutes=10)
|
||||
|
||||
SCAN_INTERVAL = timedelta(minutes=10)
|
||||
|
||||
# Supported sensor types:
|
||||
# Supported overview sensor types:
|
||||
# Key: ['json_key', 'name', unit, icon]
|
||||
SENSOR_TYPES = {
|
||||
'lifetime_energy': ['lifeTimeData', "Lifetime energy",
|
||||
|
|
@ -37,8 +42,18 @@ SENSOR_TYPES = {
|
|||
ENERGY_WATT_HOUR, 'mdi:solar-power'],
|
||||
'energy_today': ['lastDayData', "Energy today",
|
||||
ENERGY_WATT_HOUR, 'mdi:solar-power'],
|
||||
'current_power': ['currentPower', "Current Power",
|
||||
POWER_WATT, 'mdi:solar-power']
|
||||
'current_power': ['currentPower', "Current Power", POWER_WATT,
|
||||
'mdi:solar-power'],
|
||||
'site_details': [None, 'Site details', None, None],
|
||||
'meters': ['meters', 'Meters', None, None],
|
||||
'sensors': ['sensors', 'Sensors', None, None],
|
||||
'gateways': ['gateways', 'Gateways', None, None],
|
||||
'batteries': ['batteries', 'Batteries', None, None],
|
||||
'inverters': ['inverters', 'Inverters', None, None],
|
||||
'power_consumption': ['LOAD', 'Power Consumption', None, 'mdi:flash'],
|
||||
'solar_power': ['PV', 'Solar Power', None, 'mdi:solar-power'],
|
||||
'grid_power': ['GRID', 'Grid Power', None, 'mdi:power-plug'],
|
||||
'storage_power': ['STORAGE', 'Storage Power', None, 'mdi:car-battery']
|
||||
}
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
|
|
@ -55,7 +70,6 @@ _LOGGER = logging.getLogger(__name__)
|
|||
def setup_platform(hass, config, add_entities, discovery_info=None):
|
||||
"""Create the SolarEdge Monitoring API sensor."""
|
||||
import solaredge
|
||||
from requests.exceptions import HTTPError, ConnectTimeout
|
||||
|
||||
api_key = config[CONF_API_KEY]
|
||||
site_id = config[CONF_SITE_ID]
|
||||
|
|
@ -79,30 +93,66 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
|
|||
_LOGGER.error("Could not retrieve details from SolarEdge API")
|
||||
return
|
||||
|
||||
# Create solaredge data service which will retrieve and update the data.
|
||||
data = SolarEdgeData(hass, api, site_id)
|
||||
# Create sensor factory that will create sensors based on sensor_key.
|
||||
sensor_factory = SolarEdgeSensorFactory(platform_name, site_id, api)
|
||||
|
||||
# Create a new sensor for each sensor type.
|
||||
entities = []
|
||||
for sensor_key in config[CONF_MONITORED_CONDITIONS]:
|
||||
sensor = SolarEdgeSensor(platform_name, sensor_key, data)
|
||||
entities.append(sensor)
|
||||
sensor = sensor_factory.create_sensor(sensor_key)
|
||||
if sensor is not None:
|
||||
entities.append(sensor)
|
||||
|
||||
add_entities(entities, True)
|
||||
|
||||
|
||||
class SolarEdgeSensor(Entity):
|
||||
"""Representation of an SolarEdge Monitoring API sensor."""
|
||||
class SolarEdgeSensorFactory:
|
||||
"""Factory which creates sensors based on the sensor_key."""
|
||||
|
||||
def __init__(self, platform_name, sensor_key, data):
|
||||
def __init__(self, platform_name, site_id, api):
|
||||
"""Initialize the factory."""
|
||||
self.platform_name = platform_name
|
||||
|
||||
details = SolarEdgeDetailsDataService(api, site_id)
|
||||
overview = SolarEdgeOverviewDataService(api, site_id)
|
||||
inventory = SolarEdgeInventoryDataService(api, site_id)
|
||||
flow = SolarEdgePowerFlowDataService(api, site_id)
|
||||
|
||||
self.services = {
|
||||
'site_details': (SolarEdgeDetailsSensor, details)
|
||||
}
|
||||
|
||||
for key in ['lifetime_energy', 'energy_this_year', 'energy_this_month',
|
||||
'energy_today', 'current_power']:
|
||||
self.services[key] = (SolarEdgeOverviewSensor, overview)
|
||||
|
||||
for key in ['meters', 'sensors', 'gateways', 'batteries', 'inverters']:
|
||||
self.services[key] = (SolarEdgeInventorySensor, inventory)
|
||||
|
||||
for key in ['power_consumption', 'solar_power', 'grid_power',
|
||||
'storage_power']:
|
||||
self.services[key] = (SolarEdgePowerFlowSensor, flow)
|
||||
|
||||
def create_sensor(self, sensor_key):
|
||||
"""Create and return a sensor based on the sensor_key."""
|
||||
sensor_class, service = self.services[sensor_key]
|
||||
|
||||
return sensor_class(self.platform_name, sensor_key, service)
|
||||
|
||||
|
||||
class SolarEdgeSensor(Entity):
|
||||
"""Abstract class for a solaredge sensor."""
|
||||
|
||||
def __init__(self, platform_name, sensor_key, data_service):
|
||||
"""Initialize the sensor."""
|
||||
self.platform_name = platform_name
|
||||
self.sensor_key = sensor_key
|
||||
self.data = data
|
||||
self.data_service = data_service
|
||||
|
||||
self._state = None
|
||||
|
||||
self._json_key = SENSOR_TYPES[self.sensor_key][0]
|
||||
self._unit_of_measurement = SENSOR_TYPES[self.sensor_key][2]
|
||||
self._icon = SENSOR_TYPES[self.sensor_key][3]
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
|
|
@ -118,34 +168,115 @@ class SolarEdgeSensor(Entity):
|
|||
@property
|
||||
def icon(self):
|
||||
"""Return the sensor icon."""
|
||||
return SENSOR_TYPES[self.sensor_key][3]
|
||||
return self._icon
|
||||
|
||||
@property
|
||||
def state(self):
|
||||
"""Return the state of the sensor."""
|
||||
return self._state
|
||||
|
||||
|
||||
class SolarEdgeOverviewSensor(SolarEdgeSensor):
|
||||
"""Representation of an SolarEdge Monitoring API overview sensor."""
|
||||
|
||||
def __init__(self, platform_name, sensor_key, data_service):
|
||||
"""Initialize the overview sensor."""
|
||||
super().__init__(platform_name, sensor_key, data_service)
|
||||
|
||||
self._json_key = SENSOR_TYPES[self.sensor_key][0]
|
||||
|
||||
def update(self):
|
||||
"""Get the latest data from the sensor and update the state."""
|
||||
self.data.update()
|
||||
self._state = self.data.data[self._json_key]
|
||||
self.data_service.update()
|
||||
self._state = self.data_service.data[self._json_key]
|
||||
|
||||
|
||||
class SolarEdgeData:
|
||||
class SolarEdgeDetailsSensor(SolarEdgeSensor):
|
||||
"""Representation of an SolarEdge Monitoring API details sensor."""
|
||||
|
||||
def __init__(self, platform_name, sensor_key, data_service):
|
||||
"""Initialize the details sensor."""
|
||||
super().__init__(platform_name, sensor_key, data_service)
|
||||
|
||||
self._attributes = {}
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
"""Return the state attributes."""
|
||||
return self._attributes
|
||||
|
||||
def update(self):
|
||||
"""Get the latest details and update state and attributes."""
|
||||
self.data_service.update()
|
||||
self._state = self.data_service.data
|
||||
self._attributes = self.data_service.attributes
|
||||
|
||||
|
||||
class SolarEdgeInventorySensor(SolarEdgeSensor):
|
||||
"""Representation of an SolarEdge Monitoring API inventory sensor."""
|
||||
|
||||
def __init__(self, platform_name, sensor_key, data_service):
|
||||
"""Initialize the inventory sensor."""
|
||||
super().__init__(platform_name, sensor_key, data_service)
|
||||
|
||||
self._json_key = SENSOR_TYPES[self.sensor_key][0]
|
||||
|
||||
self._attributes = {}
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
"""Return the state attributes."""
|
||||
return self._attributes
|
||||
|
||||
def update(self):
|
||||
"""Get the latest inventory data and update state and attributes."""
|
||||
self.data_service.update()
|
||||
self._state = self.data_service.data[self._json_key]
|
||||
self._attributes = self.data_service.attributes[self._json_key]
|
||||
|
||||
|
||||
class SolarEdgePowerFlowSensor(SolarEdgeSensor):
|
||||
"""Representation of an SolarEdge Monitoring API power flow sensor."""
|
||||
|
||||
def __init__(self, platform_name, sensor_key, data_service):
|
||||
"""Initialize the power flow sensor."""
|
||||
super().__init__(platform_name, sensor_key, data_service)
|
||||
|
||||
self._json_key = SENSOR_TYPES[self.sensor_key][0]
|
||||
|
||||
self._attributes = {}
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
"""Return the state attributes."""
|
||||
return self._attributes
|
||||
|
||||
def update(self):
|
||||
"""Get the latest inventory data and update state and attributes."""
|
||||
self.data_service.update()
|
||||
self._state = self.data_service.data.get(self._json_key)
|
||||
self._attributes = self.data_service.attributes.get(self._json_key)
|
||||
self._unit_of_measurement = self.data_service.unit
|
||||
|
||||
|
||||
class SolarEdgeDataService:
|
||||
"""Get and update the latest data."""
|
||||
|
||||
def __init__(self, hass, api, site_id):
|
||||
def __init__(self, api, site_id):
|
||||
"""Initialize the data object."""
|
||||
self.hass = hass
|
||||
self.api = api
|
||||
self.data = {}
|
||||
self.site_id = site_id
|
||||
|
||||
@Throttle(UPDATE_DELAY)
|
||||
self.data = {}
|
||||
self.attributes = {}
|
||||
|
||||
|
||||
class SolarEdgeOverviewDataService(SolarEdgeDataService):
|
||||
"""Get and update the latest overview data."""
|
||||
|
||||
@Throttle(OVERVIEW_UPDATE_DELAY)
|
||||
def update(self):
|
||||
"""Update the data from the SolarEdge Monitoring API."""
|
||||
from requests.exceptions import HTTPError, ConnectTimeout
|
||||
|
||||
try:
|
||||
data = self.api.get_overview(self.site_id)
|
||||
overview = data['overview']
|
||||
|
|
@ -159,9 +290,141 @@ class SolarEdgeData:
|
|||
self.data = {}
|
||||
|
||||
for key, value in overview.items():
|
||||
if 'energy' in value:
|
||||
self.data[key] = value['energy']
|
||||
elif 'power' in value:
|
||||
self.data[key] = value['power']
|
||||
if key in ['lifeTimeData', 'lastYearData',
|
||||
'lastMonthData', 'lastDayData']:
|
||||
data = value['energy']
|
||||
elif key in ['currentPower']:
|
||||
data = value['power']
|
||||
else:
|
||||
data = value
|
||||
self.data[key] = data
|
||||
|
||||
_LOGGER.debug("Updated SolarEdge overview data: %s", self.data)
|
||||
_LOGGER.debug("Updated SolarEdge overview: %s", self.data)
|
||||
|
||||
|
||||
class SolarEdgeDetailsDataService(SolarEdgeDataService):
|
||||
"""Get and update the latest details data."""
|
||||
|
||||
def __init__(self, api, site_id):
|
||||
"""Initialize the details data service."""
|
||||
super().__init__(api, site_id)
|
||||
|
||||
self.data = None
|
||||
|
||||
@Throttle(DETAILS_UPDATE_DELAY)
|
||||
def update(self):
|
||||
"""Update the data from the SolarEdge Monitoring API."""
|
||||
from stringcase import snakecase
|
||||
|
||||
try:
|
||||
data = self.api.get_details(self.site_id)
|
||||
details = data['details']
|
||||
except KeyError:
|
||||
_LOGGER.error("Missing details data, skipping update")
|
||||
return
|
||||
except (ConnectTimeout, HTTPError):
|
||||
_LOGGER.error("Could not retrieve data, skipping update")
|
||||
return
|
||||
|
||||
self.data = None
|
||||
self.attributes = {}
|
||||
|
||||
for key, value in details.items():
|
||||
key = snakecase(key)
|
||||
|
||||
if key in ['primary_module']:
|
||||
for module_key, module_value in value.items():
|
||||
self.attributes[snakecase(module_key)] = module_value
|
||||
elif key in ['peak_power', 'type', 'name', 'last_update_time',
|
||||
'installation_date']:
|
||||
self.attributes[key] = value
|
||||
elif key == 'status':
|
||||
self.data = value
|
||||
|
||||
_LOGGER.debug("Updated SolarEdge details: %s, %s",
|
||||
self.data, self.attributes)
|
||||
|
||||
|
||||
class SolarEdgeInventoryDataService(SolarEdgeDataService):
|
||||
"""Get and update the latest inventory data."""
|
||||
|
||||
@Throttle(INVENTORY_UPDATE_DELAY)
|
||||
def update(self):
|
||||
"""Update the data from the SolarEdge Monitoring API."""
|
||||
try:
|
||||
data = self.api.get_inventory(self.site_id)
|
||||
inventory = data['Inventory']
|
||||
except KeyError:
|
||||
_LOGGER.error("Missing inventory data, skipping update")
|
||||
return
|
||||
except (ConnectTimeout, HTTPError):
|
||||
_LOGGER.error("Could not retrieve data, skipping update")
|
||||
return
|
||||
|
||||
self.data = {}
|
||||
self.attributes = {}
|
||||
|
||||
for key, value in inventory.items():
|
||||
self.data[key] = len(value)
|
||||
self.attributes[key] = {key: value}
|
||||
|
||||
_LOGGER.debug("Updated SolarEdge inventory: %s, %s",
|
||||
self.data, self.attributes)
|
||||
|
||||
|
||||
class SolarEdgePowerFlowDataService(SolarEdgeDataService):
|
||||
"""Get and update the latest power flow data."""
|
||||
|
||||
def __init__(self, api, site_id):
|
||||
"""Initialize the power flow data service."""
|
||||
super().__init__(api, site_id)
|
||||
|
||||
self.unit = None
|
||||
|
||||
@Throttle(POWER_FLOW_UPDATE_DELAY)
|
||||
def update(self):
|
||||
"""Update the data from the SolarEdge Monitoring API."""
|
||||
try:
|
||||
data = self.api.get_current_power_flow(self.site_id)
|
||||
power_flow = data['siteCurrentPowerFlow']
|
||||
except KeyError:
|
||||
_LOGGER.error("Missing power flow data, skipping update")
|
||||
return
|
||||
except (ConnectTimeout, HTTPError):
|
||||
_LOGGER.error("Could not retrieve data, skipping update")
|
||||
return
|
||||
|
||||
power_from = []
|
||||
power_to = []
|
||||
|
||||
if 'connections' not in power_flow:
|
||||
_LOGGER.error("Missing connections in power flow data")
|
||||
return
|
||||
|
||||
for connection in power_flow['connections']:
|
||||
power_from.append(connection['from'].lower())
|
||||
power_to.append(connection['to'].lower())
|
||||
|
||||
self.data = {}
|
||||
self.attributes = {}
|
||||
self.unit = power_flow['unit']
|
||||
|
||||
for key, value in power_flow.items():
|
||||
if key in ['LOAD', 'PV', 'GRID', 'STORAGE']:
|
||||
self.data[key] = value['currentPower']
|
||||
self.attributes[key] = {'status': value['status']}
|
||||
|
||||
if key in ['GRID']:
|
||||
export = key.lower() in power_to
|
||||
self.data[key] *= -1 if export else 1
|
||||
self.attributes[key]['flow'] = ('export' if export
|
||||
else 'import')
|
||||
|
||||
if key in ['STORAGE']:
|
||||
charge = key.lower() in power_to
|
||||
self.data[key] *= -1 if charge else 1
|
||||
self.attributes[key]['flow'] = ('charge' if charge
|
||||
else 'discharge')
|
||||
|
||||
_LOGGER.debug("Updated SolarEdge power flow: %s, %s",
|
||||
self.data, self.attributes)
|
||||
|
|
|
|||
|
|
@ -1645,6 +1645,7 @@ statsd==3.2.1
|
|||
# homeassistant.components.steam_online.sensor
|
||||
steamodd==4.21
|
||||
|
||||
# homeassistant.components.solaredge.sensor
|
||||
# homeassistant.components.thermoworks_smoke.sensor
|
||||
# homeassistant.components.traccar.device_tracker
|
||||
stringcase==1.2.0
|
||||
|
|
|
|||
Loading…
Reference in New Issue