mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 13:17:32 +00:00
Miflora (#3053)
* First version of the MiFlora sensor (not yet finished) * First workign version * Added some documentation Get name from sensor, if not defined * Ignore IOError * Added force_update option * Updated comments * Renamed fertility to conductivity (what it really is) * MiFlora library update * Updated helper files * Formatting * Fixed pylint errors * Removed default from monitored conditions * Removed KeyError handling as a KeyError should never be raised * Added a return when no data is received * emoved unnecessary return statement * Changed default name * Changes quotes and string operation ( @Teagan42 ) * - number of samples for median calculation is now configurable - set state to None if no data could be polled from sensor * Bugfix in library more logging * Fixed miflora version number
This commit is contained in:
parent
2c01a67446
commit
0c7c85dbfe
@ -227,6 +227,7 @@ omit =
|
||||
homeassistant/components/sensor/linux_battery.py
|
||||
homeassistant/components/sensor/loopenergy.py
|
||||
homeassistant/components/sensor/mhz19.py
|
||||
homeassistant/components/sensor/miflora.py
|
||||
homeassistant/components/sensor/mqtt_room.py
|
||||
homeassistant/components/sensor/neurio_energy.py
|
||||
homeassistant/components/sensor/nzbget.py
|
||||
|
151
homeassistant/components/sensor/miflora.py
Normal file
151
homeassistant/components/sensor/miflora.py
Normal file
@ -0,0 +1,151 @@
|
||||
"""
|
||||
Support for Xiaomi Mi Flora BLE plant sensor.
|
||||
|
||||
For more details about this platform, please refer to the documentation at
|
||||
https://home-assistant.io/components/sensor.miflora/
|
||||
"""
|
||||
from datetime import timedelta
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
from homeassistant.helpers.entity import Entity
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.util import Throttle
|
||||
from homeassistant.const import CONF_MONITORED_CONDITIONS, CONF_NAME
|
||||
|
||||
|
||||
REQUIREMENTS = ['miflora==0.1.6']
|
||||
|
||||
LOGGER = logging.getLogger(__name__)
|
||||
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=900)
|
||||
CONF_MAC = 'mac'
|
||||
CONF_FORCE_UPDATE = 'force_update'
|
||||
CONF_MEDIAN = 'median'
|
||||
DEFAULT_NAME = 'Mi Flora'
|
||||
|
||||
# Sensor types are defined like: Name, units
|
||||
SENSOR_TYPES = {
|
||||
'temperature': ['Temperature', '°C'],
|
||||
'light': ['Light intensity', 'lux'],
|
||||
'moisture': ['Moisture', '%'],
|
||||
'conductivity': ['Conductivity', 'µS/cm'],
|
||||
}
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Required(CONF_MAC): cv.string,
|
||||
vol.Required(CONF_MONITORED_CONDITIONS):
|
||||
vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_MEDIAN, default=3): cv.positive_int,
|
||||
vol.Optional(CONF_FORCE_UPDATE, default=False): cv.boolean,
|
||||
})
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_devices, discovery_info=None):
|
||||
"""Setup the MiFlora sensor."""
|
||||
from miflora import miflora_poller
|
||||
|
||||
poller = miflora_poller.MiFloraPoller(config.get(CONF_MAC))
|
||||
force_update = config.get(CONF_FORCE_UPDATE)
|
||||
median = config.get(CONF_MEDIAN)
|
||||
|
||||
devs = []
|
||||
|
||||
for parameter in config[CONF_MONITORED_CONDITIONS]:
|
||||
name = SENSOR_TYPES[parameter][0]
|
||||
unit = SENSOR_TYPES[parameter][1]
|
||||
|
||||
prefix = config.get(CONF_NAME)
|
||||
|
||||
if len(prefix) > 0:
|
||||
name = "{} {}".format(prefix, name)
|
||||
|
||||
devs.append(MiFloraSensor(poller,
|
||||
parameter,
|
||||
name,
|
||||
unit,
|
||||
force_update,
|
||||
median))
|
||||
|
||||
add_devices(devs)
|
||||
|
||||
|
||||
class MiFloraSensor(Entity):
|
||||
"""Implementing the MiFlora sensor."""
|
||||
|
||||
# pylint: disable=too-many-instance-attributes,too-many-arguments
|
||||
def __init__(self, poller, parameter, name, unit, force_update, median=3):
|
||||
"""Initialize the sensor."""
|
||||
self.poller = poller
|
||||
self.parameter = parameter
|
||||
self._unit = unit
|
||||
self._name = name
|
||||
self._state = None
|
||||
self.data = []
|
||||
self._force_update = force_update
|
||||
# Median is used to filter out outliers. median of 3 will filter
|
||||
# single outliers, while median of 5 will filter double outliers
|
||||
# Use median_count = 1 if no filtering is required.
|
||||
self.median_count = median
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of the sensor."""
|
||||
return self._name
|
||||
|
||||
@property
|
||||
def state(self):
|
||||
"""Return the state of the sensor."""
|
||||
return self._state
|
||||
|
||||
@property
|
||||
def unit_of_measurement(self):
|
||||
"""Return the units of measurement."""
|
||||
return self._unit
|
||||
|
||||
@property
|
||||
def force_update(self):
|
||||
"""Force update."""
|
||||
return self._force_update
|
||||
|
||||
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
||||
def update(self):
|
||||
"""
|
||||
Update current conditions.
|
||||
|
||||
This uses a rolling median over 3 values to filter out outliers.
|
||||
"""
|
||||
try:
|
||||
LOGGER.debug("Polling data for %s", self.name)
|
||||
data = self.poller.parameter_value(self.parameter)
|
||||
except IOError as ioerr:
|
||||
LOGGER.info("Polling error %s", ioerr)
|
||||
data = None
|
||||
return
|
||||
|
||||
if data is not None:
|
||||
LOGGER.debug("%s = %s", self.name, data)
|
||||
self.data.append(data)
|
||||
else:
|
||||
LOGGER.info("Did not receive any data from Mi Flora sensor %s",
|
||||
self.name)
|
||||
# Remove old data from median list or set sensor value to None
|
||||
# if no data is available anymore
|
||||
if len(self.data) > 0:
|
||||
self.data = self.data[1:]
|
||||
else:
|
||||
self._state = None
|
||||
return
|
||||
|
||||
LOGGER.debug("Data collected: %s", self.data)
|
||||
if len(self.data) > self.median_count:
|
||||
self.data = self.data[1:]
|
||||
|
||||
if len(self.data) == self.median_count:
|
||||
median = sorted(self.data)[int((self.median_count - 1) / 2)]
|
||||
LOGGER.debug("Median is: %s", median)
|
||||
self._state = median
|
||||
else:
|
||||
LOGGER.debug("Not yet enough data for median calculation")
|
@ -234,6 +234,9 @@ messagebird==1.2.0
|
||||
# homeassistant.components.switch.mfi
|
||||
mficlient==0.3.0
|
||||
|
||||
# homeassistant.components.sensor.miflora
|
||||
miflora==0.1.6
|
||||
|
||||
# homeassistant.components.discovery
|
||||
netdisco==0.7.1
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user