-
Notifications
You must be signed in to change notification settings - Fork 4
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 #67 from ChristophCaina/add-binary-sensor
Add Binary_Sensor "ValidationErrorStatus"
- Loading branch information
Showing
3 changed files
with
225 additions
and
43 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
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 |
|---|---|---|
| @@ -0,0 +1,215 @@ | ||
| """Platform for binary sensor integration.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import logging | ||
|
|
||
| import voluptuous as vol | ||
|
|
||
| from datetime import timedelta | ||
| from homeassistant.components.binary_sensor import ( | ||
| BinarySensorDeviceClass, | ||
| BinarySensorEntity, | ||
| ) | ||
| from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry | ||
| from homeassistant.core import HomeAssistant, callback | ||
| from homeassistant.exceptions import ConfigEntryNotReady | ||
| import homeassistant.helpers.config_validation as cv | ||
| from homeassistant.helpers.device_registry import DeviceInfo | ||
| from homeassistant.helpers.entity_platform import AddEntitiesCallback | ||
| from homeassistant.helpers.event import async_call_later | ||
| from homeassistant.helpers.restore_state import RestoreEntity | ||
| from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType | ||
| from homeassistant.helpers.update_coordinator import CoordinatorEntity | ||
|
|
||
| from .const import ( | ||
| TIMEOUT, | ||
| POLL_INTERVAL, | ||
| CONF_EMAIL, | ||
| CONF_PASSWORD, | ||
| CONF_HTTP_TIMEOUT, | ||
| DOMAIN, | ||
| CONF_POLL_INTERVAL, | ||
| ) | ||
| from .OilFox import OilFox | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
| BINARY_SENSORS = { | ||
| # index 0 = API Name & unique ID | ||
| # index 1 = units of measurement | ||
| # index 2 = icon | ||
| # index 3 = HA friendly name | ||
| # index 4 = device class | ||
| # index 5 = state class | ||
| "validationErrorStatus": [ | ||
| "validationErrorStatus", | ||
| None, | ||
| "mdi:alert-circle", | ||
| "validationErrorStatus", | ||
| BinarySensorDeviceClass.PROBLEM, | ||
| None, | ||
| ], | ||
| } | ||
|
|
||
| async def async_setup_entry( | ||
| hass: HomeAssistant, | ||
| config_entry: ConfigEntry, | ||
| async_add_entities: AddEntitiesCallback, | ||
| ) -> None: | ||
| """Initialize OilFox Integration config entry.""" | ||
|
|
||
| _LOGGER.info("OilFox: Setup User: %s", config_entry.data[CONF_EMAIL]) | ||
| email = config_entry.data[CONF_EMAIL] | ||
| password = config_entry.data[CONF_PASSWORD] | ||
|
|
||
| if CONF_HTTP_TIMEOUT in config_entry.options: | ||
| timeout = config_entry.options[CONF_HTTP_TIMEOUT] | ||
| _LOGGER.info( | ||
| "Load custom timeout value: %s", config_entry.options[CONF_HTTP_TIMEOUT] | ||
| ) | ||
| else: | ||
| timeout = TIMEOUT | ||
| _LOGGER.info("Load default timeout value: %s", timeout) | ||
|
|
||
| if CONF_POLL_INTERVAL in config_entry.options: | ||
| poll_interval = config_entry.options[CONF_POLL_INTERVAL] | ||
| _LOGGER.info( | ||
| "Load custom poll interval: %s", config_entry.options[CONF_POLL_INTERVAL] | ||
| ) | ||
| else: | ||
| poll_interval = POLL_INTERVAL | ||
| _LOGGER.info("Load default poll intervall: %s", poll_interval) | ||
|
|
||
| coordinator = hass.data[DOMAIN][config_entry.entry_id] | ||
| coordinator.update_interval = timedelta(minutes=poll_interval) | ||
| _LOGGER.debug("OilFox Coordinator Data Result: %s", repr(coordinator.data)) | ||
| if coordinator.data is None or coordinator.data is False: | ||
| raise ConfigEntryNotReady( | ||
| "Error on Coordinator Data Result: " + repr(coordinator.data) | ||
| ) | ||
| oilfox_devices = coordinator.data["items"] | ||
| entities = [] | ||
| for oilfox_device in oilfox_devices: | ||
| _LOGGER.info("OilFox: Found Device in API: %s", oilfox_device["hwid"]) | ||
| for binary_sensor in BINARY_SENSORS.items(): | ||
| _LOGGER.debug( | ||
| "OilFox: Create Binary-Sensor %s for Device %s", | ||
| binary_sensor[0], | ||
| oilfox_device["hwid"], | ||
| ) | ||
| oilfox_binary_sensor = OilFoxBinarySensor( | ||
| coordinator, | ||
| OilFox( | ||
| email, | ||
| password, | ||
| oilfox_device["hwid"], | ||
| timeout=timeout, | ||
| poll_interval=poll_interval, | ||
| ), | ||
| binary_sensor[1], | ||
| hass, | ||
| ) | ||
|
|
||
| oilfox_binary_sensor.set_api_response(oilfox_device) | ||
| if binary_sensor[0] == "validationErrorStatus": | ||
| if "validationError" in oilfox_device: | ||
| _LOGGER.debug( | ||
| "Prefill entity %s with %s", | ||
| binary_sensor[0], | ||
| "True", | ||
| ) | ||
| oilfox_binary_sensor._is_on = True | ||
| else: | ||
| _LOGGER.debug( | ||
| "Prefill entity %s with %s", | ||
| binary_sensor[0], | ||
| "False", | ||
| ) | ||
| oilfox_binary_sensor._is_on = False | ||
| entities.append(oilfox_binary_sensor) | ||
| async_add_entities(entities) | ||
|
|
||
| class OilFoxBinarySensor(CoordinatorEntity, BinarySensorEntity, RestoreEntity): | ||
| """OilFox BinarySensor Class.""" | ||
|
|
||
| def __init__(self, coordinator, element, binary_sensor, hass): | ||
| """Init for OilFoxBinarySensor.""" | ||
| super().__init__(coordinator) | ||
| self._hass = hass | ||
| self._attr_device_class = binary_sensor[4] | ||
| self.binary_sensor = binary_sensor | ||
| self.oilfox = element | ||
| self._is_on = None | ||
| self.api_response: list[SensorStateClass] | ||
| self._extra_state_attributes = {} | ||
|
|
||
| @callback | ||
| def _handle_coordinator_update(self) -> None: | ||
| """Handle updated data from the coordinator.""" | ||
| oilfox_devices = self.coordinator.data["items"] | ||
| for oilfox_device in oilfox_devices: | ||
| if oilfox_device["hwid"] == self.oilfox.hwid: | ||
| self.set_api_response(oilfox_device) | ||
| if self.binary_sensor[0] == "validationErrorStatus": | ||
| self._is_on = False | ||
| if "validationError" in oilfox_device: | ||
| self._is_on = True | ||
| else: | ||
| self._is_on = False | ||
| _LOGGER.debug( | ||
| "Update entity %s for HWID %s with value: %s", | ||
| self.binary_sensor[0], | ||
| self.oilfox.hwid, | ||
| self._is_on, | ||
| ) | ||
| self.async_write_ha_state() | ||
| return None | ||
|
|
||
| @property | ||
| def extra_state_attributes(self): | ||
| """Get extra Attribute.""" | ||
| return self._extra_state_attributes | ||
|
|
||
| def set_api_response(self, response): | ||
| """Set API response manual.""" | ||
| self.api_response = response | ||
|
|
||
| @property | ||
| def extra_state_attributes(self): | ||
| """Get extra Attribute.""" | ||
| return self._extra_state_attributes | ||
|
|
||
| def set_api_response(self, response): | ||
| """Set API response manual.""" | ||
| self.api_response = response | ||
|
|
||
| @property | ||
| def icon(self) -> str: | ||
| """Return the name of the sensor.""" | ||
| return self.binary_sensor[2] | ||
|
|
||
| @property | ||
| def unique_id(self) -> str: | ||
| """Return the unique_id of the sensor.""" | ||
|
|
||
| """Dirty workaround: entites meteringAt did use self.sensor[3] instead of self.sensor[0] as ID before ha-oilfox version 0.1.8""" | ||
| return "OilFox-" + self.oilfox.hwid + "-" + self.binary_sensor[0] | ||
|
|
||
| @property | ||
| def name(self) -> str: | ||
| """Return the name of the sensor.""" | ||
| return "OilFox-" + self.oilfox.hwid + "-" + self.binary_sensor[3] | ||
|
|
||
| @property | ||
| def is_on(self) -> None: | ||
| """Return the state of the sensor.""" | ||
| return self._is_on | ||
|
|
||
| @property | ||
| def device_info(self) -> DeviceInfo: | ||
| """Return the device info.""" | ||
| return DeviceInfo( | ||
| identifiers={(DOMAIN, self.oilfox.hwid)}, | ||
| name="OilFox-" + self.oilfox.hwid, | ||
| ) |
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