-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from barleybobs/dev
Replace device_state_attributes with extra_state_attributes
- Loading branch information
Showing
1 changed file
with
143 additions
and
143 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,143 +1,143 @@ | ||
| """Ecowater sensor platform.""" | ||
| from datetime import datetime, timedelta | ||
| import logging | ||
| import re | ||
| from typing import Any, Callable, Dict, Optional | ||
|
|
||
| from ecowater_softener import Ecowater | ||
|
|
||
| from aiohttp import ClientError | ||
| from homeassistant import config_entries, core | ||
| from homeassistant.components.sensor import PLATFORM_SCHEMA | ||
| from homeassistant.const import ( | ||
| ATTR_NAME, | ||
| CONF_ACCESS_TOKEN, | ||
| CONF_NAME, | ||
| CONF_PATH, | ||
| CONF_URL, | ||
| ) | ||
| from homeassistant.helpers.aiohttp_client import async_get_clientsession | ||
| import homeassistant.helpers.config_validation as cv | ||
| from homeassistant.helpers.entity import Entity | ||
| from homeassistant.helpers.typing import ( | ||
| ConfigType, | ||
| DiscoveryInfoType, | ||
| HomeAssistantType, | ||
| ) | ||
| import voluptuous as vol | ||
|
|
||
| from .const import ( | ||
| ATTR_STATUS, | ||
| ATTR_DAYS_UNTIL_OUT_OF_SALT, | ||
| ATTR_OUT_OF_SALT_ON, | ||
| ATTR_SALT_LEVEL_PERCENTAGE, | ||
| ATTR_WATER_USAGE_TODAY, | ||
| ATTR_WATER_USAGE_DAILY_AVERAGE, | ||
| ATTR_WATER_AVAILABLE, | ||
| ATTR_WATER_UNITS, | ||
| ATTR_RECHARGE_ENABLED, | ||
| ATTR_RECHARGE_SCHEDULED, | ||
| DOMAIN, | ||
| ) | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
| # Time between updating data from Ecowater | ||
| SCAN_INTERVAL = timedelta(minutes=30) | ||
|
|
||
| async def async_setup_entry( | ||
| hass: core.HomeAssistant, | ||
| config_entry: config_entries.ConfigEntry, | ||
| async_add_entities, | ||
| ): | ||
| """Setup sensors from a config entry created in the integrations UI.""" | ||
| config = hass.data[DOMAIN][config_entry.entry_id] | ||
| # Update our config to include new repos and remove those that have been removed. | ||
| if config_entry.options: | ||
| config.update(config_entry.options) | ||
| session = async_get_clientsession(hass) | ||
| username = config["username"] | ||
| password = config["password"] | ||
| serialnumber = config["serialnumber"] | ||
| dateformat = config["dateformat"] | ||
| sensors = [EcowaterSensor(username, password, serialnumber, dateformat)] | ||
| async_add_entities(sensors, update_before_add=True) | ||
|
|
||
| class EcowaterSensor(Entity): | ||
| """Representation of a Ecowater water softener sensor.""" | ||
|
|
||
| def __init__(self, username, password, serialnumber, dateformat): | ||
| super().__init__() | ||
| self._attrs: dict[str, Any] = {} | ||
| self._icon = 'mdi:water' | ||
| self._state = None | ||
| self._available = True | ||
| self._username = username | ||
| self._password = password | ||
| self._serialnumber = serialnumber | ||
| self._dateformat = dateformat | ||
| self._name = "Ecowater " + self._serialnumber | ||
|
|
||
| @property | ||
| def name(self) -> str: | ||
| """Return the name of the entity.""" | ||
| return self._name | ||
|
|
||
| @property | ||
| def icon(self): | ||
| """Return the icon of the entity.""" | ||
| return self._icon | ||
|
|
||
| @property | ||
| def unique_id(self) -> str: | ||
| """Return the unique ID of the sensor.""" | ||
| return "Ecowater-" + self._serialnumber | ||
|
|
||
| @property | ||
| def available(self) -> bool: | ||
| """Return True if entity is available.""" | ||
| return self._available | ||
|
|
||
| @property | ||
| def state(self) -> Optional[str]: | ||
| return self._state | ||
|
|
||
| @property | ||
| def device_state_attributes(self) -> Dict[str, Any]: | ||
| return self._attrs | ||
|
|
||
| async def async_update(self): | ||
| try: | ||
| ecowaterDevice = Ecowater(self._username, self._password, self._serialnumber) | ||
| data_json = await self.hass.async_add_executor_job(lambda: ecowaterDevice._get()) | ||
|
|
||
| nextRecharge_re = "device-info-nextRecharge'\)\.html\('(?P<nextRecharge>.*)'" | ||
|
|
||
| self._attrs[ATTR_STATUS] = 'Online' if data_json['online'] == True else 'Offline' | ||
| self._attrs[ATTR_DAYS_UNTIL_OUT_OF_SALT] = data_json['out_of_salt_days'] | ||
|
|
||
| """Runs correct datetime.strptime() depending on date format entered during setup.""" | ||
| if self._dateformat == "dd/mm/yyyy": | ||
| self._attrs[ATTR_OUT_OF_SALT_ON] = datetime.strptime(data_json['out_of_salt'], '%d/%m/%Y').strftime('%Y-%m-%d') | ||
| elif self._dateformat == "mm/dd/yyyy": | ||
| self._attrs[ATTR_OUT_OF_SALT_ON] = datetime.strptime(data_json['out_of_salt'], '%m/%d/%Y').strftime('%Y-%m-%d') | ||
| else: | ||
| self._attrs[ATTR_OUT_OF_SALT_ON] = '' | ||
| _LOGGER.exception( | ||
| f"Error: Date format not set" | ||
| ) | ||
|
|
||
| self._attrs[ATTR_SALT_LEVEL_PERCENTAGE] = data_json['salt_level_percent'] | ||
| self._attrs[ATTR_WATER_USAGE_TODAY] = data_json['water_today'] | ||
| self._attrs[ATTR_WATER_USAGE_DAILY_AVERAGE] = data_json['water_avg'] | ||
| self._attrs[ATTR_WATER_AVAILABLE] = data_json['water_avail'] | ||
| self._attrs[ATTR_WATER_UNITS] = str(data_json['water_units']) | ||
| self._attrs[ATTR_RECHARGE_ENABLED] = data_json['rechargeEnabled'] | ||
| self._attrs[ATTR_RECHARGE_SCHEDULED] = False if ( re.search(nextRecharge_re, data_json['recharge']) ).group('nextRecharge') == 'Not Scheduled' else True | ||
| self._state = 'Online' if data_json['online'] == True else 'Offline' | ||
| self._available = True | ||
|
|
||
| except Exception as e: | ||
| self._available = False | ||
| _LOGGER.exception( | ||
| f"Error: {e}" | ||
| ) | ||
| """Ecowater sensor platform.""" | ||
| from datetime import datetime, timedelta | ||
| import logging | ||
| import re | ||
| from typing import Any, Callable, Dict, Optional | ||
|
|
||
| from ecowater_softener import Ecowater | ||
|
|
||
| from aiohttp import ClientError | ||
| from homeassistant import config_entries, core | ||
| from homeassistant.components.sensor import PLATFORM_SCHEMA | ||
| from homeassistant.const import ( | ||
| ATTR_NAME, | ||
| CONF_ACCESS_TOKEN, | ||
| CONF_NAME, | ||
| CONF_PATH, | ||
| CONF_URL, | ||
| ) | ||
| from homeassistant.helpers.aiohttp_client import async_get_clientsession | ||
| import homeassistant.helpers.config_validation as cv | ||
| from homeassistant.helpers.entity import Entity | ||
| from homeassistant.helpers.typing import ( | ||
| ConfigType, | ||
| DiscoveryInfoType, | ||
| HomeAssistantType, | ||
| ) | ||
| import voluptuous as vol | ||
|
|
||
| from .const import ( | ||
| ATTR_STATUS, | ||
| ATTR_DAYS_UNTIL_OUT_OF_SALT, | ||
| ATTR_OUT_OF_SALT_ON, | ||
| ATTR_SALT_LEVEL_PERCENTAGE, | ||
| ATTR_WATER_USAGE_TODAY, | ||
| ATTR_WATER_USAGE_DAILY_AVERAGE, | ||
| ATTR_WATER_AVAILABLE, | ||
| ATTR_WATER_UNITS, | ||
| ATTR_RECHARGE_ENABLED, | ||
| ATTR_RECHARGE_SCHEDULED, | ||
| DOMAIN, | ||
| ) | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
| # Time between updating data from Ecowater | ||
| SCAN_INTERVAL = timedelta(minutes=30) | ||
|
|
||
| async def async_setup_entry( | ||
| hass: core.HomeAssistant, | ||
| config_entry: config_entries.ConfigEntry, | ||
| async_add_entities, | ||
| ): | ||
| """Setup sensors from a config entry created in the integrations UI.""" | ||
| config = hass.data[DOMAIN][config_entry.entry_id] | ||
| # Update our config to include new repos and remove those that have been removed. | ||
| if config_entry.options: | ||
| config.update(config_entry.options) | ||
| session = async_get_clientsession(hass) | ||
| username = config["username"] | ||
| password = config["password"] | ||
| serialnumber = config["serialnumber"] | ||
| dateformat = config["dateformat"] | ||
| sensors = [EcowaterSensor(username, password, serialnumber, dateformat)] | ||
| async_add_entities(sensors, update_before_add=True) | ||
|
|
||
| class EcowaterSensor(Entity): | ||
| """Representation of a Ecowater water softener sensor.""" | ||
|
|
||
| def __init__(self, username, password, serialnumber, dateformat): | ||
| super().__init__() | ||
| self._attrs: dict[str, Any] = {} | ||
| self._icon = 'mdi:water' | ||
| self._state = None | ||
| self._available = True | ||
| self._username = username | ||
| self._password = password | ||
| self._serialnumber = serialnumber | ||
| self._dateformat = dateformat | ||
| self._name = "Ecowater " + self._serialnumber | ||
|
|
||
| @property | ||
| def name(self) -> str: | ||
| """Return the name of the entity.""" | ||
| return self._name | ||
|
|
||
| @property | ||
| def icon(self): | ||
| """Return the icon of the entity.""" | ||
| return self._icon | ||
|
|
||
| @property | ||
| def unique_id(self) -> str: | ||
| """Return the unique ID of the sensor.""" | ||
| return "Ecowater-" + self._serialnumber | ||
|
|
||
| @property | ||
| def available(self) -> bool: | ||
| """Return True if entity is available.""" | ||
| return self._available | ||
|
|
||
| @property | ||
| def state(self) -> Optional[str]: | ||
| return self._state | ||
|
|
||
| @property | ||
| def extra_state_attributes(self) -> Dict[str, Any]: | ||
| return self._attrs | ||
|
|
||
| async def async_update(self): | ||
| try: | ||
| ecowaterDevice = Ecowater(self._username, self._password, self._serialnumber) | ||
| data_json = await self.hass.async_add_executor_job(lambda: ecowaterDevice._get()) | ||
|
|
||
| nextRecharge_re = "device-info-nextRecharge'\)\.html\('(?P<nextRecharge>.*)'" | ||
|
|
||
| self._attrs[ATTR_STATUS] = 'Online' if data_json['online'] == True else 'Offline' | ||
| self._attrs[ATTR_DAYS_UNTIL_OUT_OF_SALT] = data_json['out_of_salt_days'] | ||
|
|
||
| #Runs correct datetime.strptime() depending on date format entered during setup. | ||
| if self._dateformat == "dd/mm/yyyy": | ||
| self._attrs[ATTR_OUT_OF_SALT_ON] = datetime.strptime(data_json['out_of_salt'], '%d/%m/%Y').strftime('%Y-%m-%d') | ||
| elif self._dateformat == "mm/dd/yyyy": | ||
| self._attrs[ATTR_OUT_OF_SALT_ON] = datetime.strptime(data_json['out_of_salt'], '%m/%d/%Y').strftime('%Y-%m-%d') | ||
| else: | ||
| self._attrs[ATTR_OUT_OF_SALT_ON] = '' | ||
| _LOGGER.exception( | ||
| f"Error: Date format not set" | ||
| ) | ||
|
|
||
| self._attrs[ATTR_SALT_LEVEL_PERCENTAGE] = data_json['salt_level_percent'] | ||
| self._attrs[ATTR_WATER_USAGE_TODAY] = data_json['water_today'] | ||
| self._attrs[ATTR_WATER_USAGE_DAILY_AVERAGE] = data_json['water_avg'] | ||
| self._attrs[ATTR_WATER_AVAILABLE] = data_json['water_avail'] | ||
| self._attrs[ATTR_WATER_UNITS] = str(data_json['water_units']) | ||
| self._attrs[ATTR_RECHARGE_ENABLED] = data_json['rechargeEnabled'] | ||
| self._attrs[ATTR_RECHARGE_SCHEDULED] = False if ( re.search(nextRecharge_re, data_json['recharge']) ).group('nextRecharge') == 'Not Scheduled' else True | ||
| self._state = 'Online' if data_json['online'] == True else 'Offline' | ||
| self._available = True | ||
|
|
||
| except Exception as e: | ||
| self._available = False | ||
| _LOGGER.exception( | ||
| f"Error: {e}" | ||
| ) |