evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactor bme280, add SPI support (#48775)

Browse source 
* bme280 refactoring, add SPI support

* isort, requirements

* __init_.py add to .coveragerc

* Re-run CI jobs

* const.py to .coveragerc

* Add support for IoT class in manifest

* Keepalive

* review suggestions

* scan_interval with coordinator

* black, isort

* coordinator review suggestions

* Set device_class

* review suggestions

* review suggestions

* review suggestions

* review suggestions

* review suggestions

* review suggestions

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* add bme280spi to commented requirements

* run script.gen_requirements_all

* black

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Kuzj 2021-07-27 23:29:43 +03:00 • committed by GitHub
parent 7ad7cdad3d
commit d0b9d82287
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 272 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.coveragerc
View file

@ -112,6 +112,8 @@ omit =
homeassistant/components/bloomsky/* homeassistant/components/bloomsky/*
homeassistant/components/bluesound/* homeassistant/components/bluesound/*
homeassistant/components/bluetooth_tracker/* homeassistant/components/bluetooth_tracker/*
homeassistant/components/bme280/__init__.py
homeassistant/components/bme280/const.py
homeassistant/components/bme280/sensor.py homeassistant/components/bme280/sensor.py
homeassistant/components/bme680/sensor.py homeassistant/components/bme680/sensor.py
homeassistant/components/bmp280/sensor.py homeassistant/components/bmp280/sensor.py

97
homeassistant/components/bme280/__init__.py
View file

@ -1 +1,98 @@
"""The bme280 component.""" """The bme280 component."""
import voluptuous as vol
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
from homeassistant.const import CONF_MONITORED_CONDITIONS, CONF_NAME, CONF_SCAN_INTERVAL
from homeassistant.helpers import config_validation as cv, discovery
from .const import (
CONF_DELTA_TEMP,
CONF_FILTER_MODE,
CONF_I2C_ADDRESS,
CONF_I2C_BUS,
CONF_OPERATION_MODE,
CONF_OVERSAMPLING_HUM,
CONF_OVERSAMPLING_PRES,
CONF_OVERSAMPLING_TEMP,
CONF_SPI_BUS,
CONF_SPI_DEV,
CONF_T_STANDBY,
DEFAULT_DELTA_TEMP,
DEFAULT_FILTER_MODE,
DEFAULT_I2C_ADDRESS,
DEFAULT_I2C_BUS,
DEFAULT_MONITORED,
DEFAULT_NAME,
DEFAULT_OPERATION_MODE,
DEFAULT_OVERSAMPLING_HUM,
DEFAULT_OVERSAMPLING_PRES,
DEFAULT_OVERSAMPLING_TEMP,
DEFAULT_SCAN_INTERVAL,
DEFAULT_T_STANDBY,
DOMAIN,
SENSOR_TYPES,
)
CONFIG_SCHEMA = vol.Schema(
{
DOMAIN: vol.All(
cv.ensure_list,
[
vol.Schema(
{
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_SPI_BUS): vol.Coerce(int),
vol.Optional(CONF_SPI_DEV): vol.Coerce(int),
vol.Optional(
CONF_I2C_ADDRESS, default=DEFAULT_I2C_ADDRESS
): cv.string,
vol.Optional(CONF_I2C_BUS, default=DEFAULT_I2C_BUS): vol.Coerce(
int
),
vol.Optional(
CONF_DELTA_TEMP, default=DEFAULT_DELTA_TEMP
): vol.Coerce(float),
vol.Optional(
CONF_MONITORED_CONDITIONS, default=DEFAULT_MONITORED
): vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
vol.Optional(
CONF_OVERSAMPLING_TEMP, default=DEFAULT_OVERSAMPLING_TEMP
): vol.Coerce(int),
vol.Optional(
CONF_OVERSAMPLING_PRES, default=DEFAULT_OVERSAMPLING_PRES
): vol.Coerce(int),
vol.Optional(
CONF_OVERSAMPLING_HUM, default=DEFAULT_OVERSAMPLING_HUM
): vol.Coerce(int),
vol.Optional(
CONF_OPERATION_MODE, default=DEFAULT_OPERATION_MODE
): vol.Coerce(int),
vol.Optional(
CONF_T_STANDBY, default=DEFAULT_T_STANDBY
): vol.Coerce(int),
vol.Optional(
CONF_FILTER_MODE, default=DEFAULT_FILTER_MODE
): vol.Coerce(int),
vol.Optional(
CONF_SCAN_INTERVAL, default=DEFAULT_SCAN_INTERVAL
): cv.time_period,
}
)
],
)
},
extra=vol.ALLOW_EXTRA,
)
async def async_setup(hass, config):
"""Set up BME280 component."""
bme280_config = config[DOMAIN]
for bme280_conf in bme280_config:
discovery_info = {SENSOR_DOMAIN: bme280_conf}
hass.async_create_task(
discovery.async_load_platform(
hass, SENSOR_DOMAIN, DOMAIN, discovery_info, config
)
)
return True

46
homeassistant/components/bme280/const.py Normal file
View file

@ -0,0 +1,46 @@
"""Constants for the BME280 component."""
from datetime import timedelta
from homeassistant.const import (
DEVICE_CLASS_HUMIDITY,
DEVICE_CLASS_PRESSURE,
DEVICE_CLASS_TEMPERATURE,
PERCENTAGE,
)
# Common
DOMAIN = "bme280"
CONF_OVERSAMPLING_TEMP = "oversampling_temperature"
CONF_OVERSAMPLING_PRES = "oversampling_pressure"
CONF_OVERSAMPLING_HUM = "oversampling_humidity"
CONF_T_STANDBY = "time_standby"
CONF_FILTER_MODE = "filter_mode"
DEFAULT_NAME = "BME280 Sensor"
DEFAULT_OVERSAMPLING_TEMP = 1
DEFAULT_OVERSAMPLING_PRES = 1
DEFAULT_OVERSAMPLING_HUM = 1
DEFAULT_T_STANDBY = 5
DEFAULT_FILTER_MODE = 0
DEFAULT_SCAN_INTERVAL = 300
SENSOR_TEMP = "temperature"
SENSOR_HUMID = "humidity"
SENSOR_PRESS = "pressure"
SENSOR_TYPES = {
SENSOR_TEMP: ["Temperature", None, DEVICE_CLASS_TEMPERATURE],
SENSOR_HUMID: ["Humidity", PERCENTAGE, DEVICE_CLASS_HUMIDITY],
SENSOR_PRESS: ["Pressure", "mb", DEVICE_CLASS_PRESSURE],
}
DEFAULT_MONITORED = [SENSOR_TEMP, SENSOR_HUMID, SENSOR_PRESS]
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=3)
# SPI
CONF_SPI_DEV = "spi_dev"
CONF_SPI_BUS = "spi_bus"
# I2C
CONF_I2C_ADDRESS = "i2c_address"
CONF_I2C_BUS = "i2c_bus"
CONF_DELTA_TEMP = "delta_temperature"
CONF_OPERATION_MODE = "operation_mode"
DEFAULT_OPERATION_MODE = 3 # Normal mode (forced mode: 2)
DEFAULT_I2C_ADDRESS = "0x76"
DEFAULT_I2C_BUS = 1
DEFAULT_DELTA_TEMP = 0.0

6
homeassistant/components/bme280/manifest.json
View file

@ -2,7 +2,11 @@
"domain": "bme280", "domain": "bme280",
"name": "Bosch BME280 Environmental Sensor", "name": "Bosch BME280 Environmental Sensor",
"documentation": "https://www.home-assistant.io/integrations/bme280", "documentation": "https://www.home-assistant.io/integrations/bme280",
"requirements": ["i2csense==0.0.4", "smbus-cffi==0.5.1"], "requirements": [
"i2csense==0.0.4",
"smbus-cffi==0.5.1",
"bme280spi==0.2.0"
],
"codeowners": [], "codeowners": [],
"iot_class": "local_push" "iot_class": "local_push"
} }

252
homeassistant/components/bme280/sensor.py
View file

@ -1,166 +1,150 @@
"""Support for BME280 temperature, humidity and pressure sensor.""" """Support for BME280 temperature, humidity and pressure sensor."""
from contextlib import suppress
from datetime import timedelta
from functools import partial from functools import partial
import logging import logging
from i2csense.bme280 import BME280 # pylint: disable=import-error from bme280spi import BME280 as BME280_spi # pylint: disable=import-error
from i2csense.bme280 import BME280 as BME280_i2c # pylint: disable=import-error
import smbus import smbus
import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN, SensorEntity
from homeassistant.const import ( from homeassistant.const import (
CONF_MONITORED_CONDITIONS, CONF_MONITORED_CONDITIONS,
CONF_NAME, CONF_NAME,
DEVICE_CLASS_HUMIDITY, CONF_SCAN_INTERVAL,
DEVICE_CLASS_PRESSURE,
DEVICE_CLASS_TEMPERATURE,
PERCENTAGE,
TEMP_FAHRENHEIT, TEMP_FAHRENHEIT,
) )
import homeassistant.helpers.config_validation as cv from homeassistant.helpers.update_coordinator import (
from homeassistant.util import Throttle CoordinatorEntity,
DataUpdateCoordinator,
UpdateFailed,
)
from homeassistant.util.temperature import celsius_to_fahrenheit from homeassistant.util.temperature import celsius_to_fahrenheit
_LOGGER = logging.getLogger(__name__) from .const import (
CONF_DELTA_TEMP,
CONF_I2C_ADDRESS = "i2c_address" CONF_FILTER_MODE,
CONF_I2C_BUS = "i2c_bus" CONF_I2C_ADDRESS,
CONF_OVERSAMPLING_TEMP = "oversampling_temperature" CONF_I2C_BUS,
CONF_OVERSAMPLING_PRES = "oversampling_pressure" CONF_OPERATION_MODE,
CONF_OVERSAMPLING_HUM = "oversampling_humidity" CONF_OVERSAMPLING_HUM,
CONF_OPERATION_MODE = "operation_mode" CONF_OVERSAMPLING_PRES,
CONF_T_STANDBY = "time_standby" CONF_OVERSAMPLING_TEMP,
CONF_FILTER_MODE = "filter_mode" CONF_SPI_BUS,
CONF_DELTA_TEMP = "delta_temperature" CONF_SPI_DEV,
CONF_T_STANDBY,
DEFAULT_NAME = "BME280 Sensor" DOMAIN,
DEFAULT_I2C_ADDRESS = "0x76" MIN_TIME_BETWEEN_UPDATES,
DEFAULT_I2C_BUS = 1 SENSOR_HUMID,
DEFAULT_OVERSAMPLING_TEMP = 1 # Temperature oversampling x 1 SENSOR_PRESS,
DEFAULT_OVERSAMPLING_PRES = 1 # Pressure oversampling x 1 SENSOR_TEMP,
DEFAULT_OVERSAMPLING_HUM = 1 # Humidity oversampling x 1 SENSOR_TYPES,
DEFAULT_OPERATION_MODE = 3 # Normal mode (forced mode: 2)
DEFAULT_T_STANDBY = 5 # Tstandby 5ms
DEFAULT_FILTER_MODE = 0 # Filter off
DEFAULT_DELTA_TEMP = 0.0
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=3)
SENSOR_TEMP = "temperature"
SENSOR_HUMID = "humidity"
SENSOR_PRESS = "pressure"
SENSOR_TYPES = {
SENSOR_TEMP: ["Temperature", None, DEVICE_CLASS_TEMPERATURE],
SENSOR_HUMID: ["Humidity", PERCENTAGE, DEVICE_CLASS_HUMIDITY],
SENSOR_PRESS: ["Pressure", "mb", DEVICE_CLASS_PRESSURE],
}
DEFAULT_MONITORED = [SENSOR_TEMP, SENSOR_HUMID, SENSOR_PRESS]
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
{
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_I2C_ADDRESS, default=DEFAULT_I2C_ADDRESS): cv.string,
vol.Optional(CONF_MONITORED_CONDITIONS, default=DEFAULT_MONITORED): vol.All(
cv.ensure_list, [vol.In(SENSOR_TYPES)]
),
vol.Optional(CONF_I2C_BUS, default=DEFAULT_I2C_BUS): vol.Coerce(int),
vol.Optional(
CONF_OVERSAMPLING_TEMP, default=DEFAULT_OVERSAMPLING_TEMP
): vol.Coerce(int),
vol.Optional(
CONF_OVERSAMPLING_PRES, default=DEFAULT_OVERSAMPLING_PRES
): vol.Coerce(int),
vol.Optional(
CONF_OVERSAMPLING_HUM, default=DEFAULT_OVERSAMPLING_HUM
): vol.Coerce(int),
vol.Optional(CONF_OPERATION_MODE, default=DEFAULT_OPERATION_MODE): vol.Coerce(
int
),
vol.Optional(CONF_T_STANDBY, default=DEFAULT_T_STANDBY): vol.Coerce(int),
vol.Optional(CONF_FILTER_MODE, default=DEFAULT_FILTER_MODE): vol.Coerce(int),
vol.Optional(CONF_DELTA_TEMP, default=DEFAULT_DELTA_TEMP): vol.Coerce(float),
}
) )
_LOGGER = logging.getLogger(__name__)
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None): async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
"""Set up the BME280 sensor.""" """Set up the BME280 sensor."""
if discovery_info is None:
return
SENSOR_TYPES[SENSOR_TEMP][1] = hass.config.units.temperature_unit SENSOR_TYPES[SENSOR_TEMP][1] = hass.config.units.temperature_unit
name = config[CONF_NAME] sensor_conf = discovery_info[SENSOR_DOMAIN]
i2c_address = config[CONF_I2C_ADDRESS] name = sensor_conf[CONF_NAME]
scan_interval = max(sensor_conf[CONF_SCAN_INTERVAL], MIN_TIME_BETWEEN_UPDATES)
bus = smbus.SMBus(config[CONF_I2C_BUS]) if CONF_SPI_BUS in sensor_conf and CONF_SPI_DEV in sensor_conf:
sensor = await hass.async_add_executor_job( spi_dev = sensor_conf[CONF_SPI_DEV]
partial( spi_bus = sensor_conf[CONF_SPI_BUS]
BME280, _LOGGER.debug("BME280 sensor initialize at %s.%s", spi_bus, spi_dev)
bus, sensor = await hass.async_add_executor_job(
i2c_address, partial(
osrs_t=config[CONF_OVERSAMPLING_TEMP], BME280_spi,
osrs_p=config[CONF_OVERSAMPLING_PRES], t_mode=sensor_conf[CONF_OVERSAMPLING_TEMP],
osrs_h=config[CONF_OVERSAMPLING_HUM], p_mode=sensor_conf[CONF_OVERSAMPLING_PRES],
mode=config[CONF_OPERATION_MODE], h_mode=sensor_conf[CONF_OVERSAMPLING_HUM],
t_sb=config[CONF_T_STANDBY], standby=sensor_conf[CONF_T_STANDBY],
filter_mode=config[CONF_FILTER_MODE], filter=sensor_conf[CONF_FILTER_MODE],
delta_temp=config[CONF_DELTA_TEMP], spi_bus=sensor_conf[CONF_SPI_BUS],
logger=_LOGGER, spi_dev=sensor_conf[CONF_SPI_DEV],
)
)
if not sensor.sample_ok:
_LOGGER.error("BME280 sensor not detected at %s", i2c_address)
return False
sensor_handler = await hass.async_add_executor_job(BME280Handler, sensor)
dev = []
with suppress(KeyError):
for variable in config[CONF_MONITORED_CONDITIONS]:
dev.append(
BME280Sensor(sensor_handler, variable, SENSOR_TYPES[variable][1], name)
) )
)
if not sensor.sample_ok:
_LOGGER.error("BME280 sensor not detected at %s.%s", spi_bus, spi_dev)
return
else:
i2c_address = sensor_conf[CONF_I2C_ADDRESS]
bus = smbus.SMBus(sensor_conf[CONF_I2C_BUS])
sensor = await hass.async_add_executor_job(
partial(
BME280_i2c,
bus,
i2c_address,
osrs_t=sensor_conf[CONF_OVERSAMPLING_TEMP],
osrs_p=sensor_conf[CONF_OVERSAMPLING_PRES],
osrs_h=sensor_conf[CONF_OVERSAMPLING_HUM],
mode=sensor_conf[CONF_OPERATION_MODE],
t_sb=sensor_conf[CONF_T_STANDBY],
filter_mode=sensor_conf[CONF_FILTER_MODE],
delta_temp=sensor_conf[CONF_DELTA_TEMP],
)
)
if not sensor.sample_ok:
_LOGGER.error("BME280 sensor not detected at %s", i2c_address)
return
async_add_entities(dev, True) async def async_update_data():
await hass.async_add_executor_job(sensor.update)
if not sensor.sample_ok:
raise UpdateFailed(f"Bad update of sensor {name}")
return sensor
coordinator = DataUpdateCoordinator(
hass,
_LOGGER,
name=DOMAIN,
update_method=async_update_data,
update_interval=scan_interval,
)
await coordinator.async_refresh()
entities = []
for condition in sensor_conf[CONF_MONITORED_CONDITIONS]:
entities.append(
BME280Sensor(
condition,
SENSOR_TYPES[condition][1],
name,
coordinator,
)
)
async_add_entities(entities, True)
class BME280Handler: class BME280Sensor(CoordinatorEntity, SensorEntity):
"""BME280 sensor working in i2C bus."""
def __init__(self, sensor):
"""Initialize the sensor handler."""
self.sensor = sensor
self.update(True)
@Throttle(MIN_TIME_BETWEEN_UPDATES)
def update(self, first_reading=False):
"""Read sensor data."""
self.sensor.update(first_reading)
class BME280Sensor(SensorEntity):
"""Implementation of the BME280 sensor.""" """Implementation of the BME280 sensor."""
def __init__(self, bme280_client, sensor_type, temp_unit, name): def __init__(self, sensor_type, temp_unit, name, coordinator):
"""Initialize the sensor.""" """Initialize the sensor."""
super().__init__(coordinator)
self._attr_name = f"{name} {SENSOR_TYPES[sensor_type][0]}" self._attr_name = f"{name} {SENSOR_TYPES[sensor_type][0]}"
self.bme280_client = bme280_client
self.temp_unit = temp_unit self.temp_unit = temp_unit
self.type = sensor_type self.type = sensor_type
self._attr_unit_of_measurement = SENSOR_TYPES[sensor_type][1] self._attr_unit_of_measurement = SENSOR_TYPES[sensor_type][1]
self._attr_device_class = SENSOR_TYPES[sensor_type][2] self._attr_device_class = SENSOR_TYPES[sensor_type][2]
async def async_update(self): @property
"""Get the latest data from the BME280 and update the states.""" def state(self):
await self.hass.async_add_executor_job(self.bme280_client.update) """Return the state of the sensor."""
if self.bme280_client.sensor.sample_ok: if self.type == SENSOR_TEMP:
if self.type == SENSOR_TEMP: temperature = round(self.coordinator.data.temperature, 1)
if self.temp_unit == TEMP_FAHRENHEIT: if self.temp_unit == TEMP_FAHRENHEIT:
self._attr_state = round(celsius_to_fahrenheit(self.state), 2) temperature = round(celsius_to_fahrenheit(temperature), 1)
else: state = temperature
self._attr_state = round(self.bme280_client.sensor.temperature, 2) elif self.type == SENSOR_HUMID:
elif self.type == SENSOR_HUMID: state = round(self.coordinator.data.humidity, 1)
self._attr_state = round(self.bme280_client.sensor.humidity, 1) elif self.type == SENSOR_PRESS:
elif self.type == SENSOR_PRESS: state = round(self.coordinator.data.pressure, 1)
self._attr_state = round(self.bme280_client.sensor.pressure, 1) return state
else:
_LOGGER.warning("Bad update of sensor.%s", self.name) @property
def should_poll(self) -> bool:
"""Return False if entity should not poll."""
return False

3
requirements_all.txt
View file

@ -391,6 +391,9 @@ blockchain==1.4.4
# homeassistant.components.miflora # homeassistant.components.miflora
# bluepy==1.3.0 # bluepy==1.3.0
# homeassistant.components.bme280
# bme280spi==0.2.0
# homeassistant.components.bme680 # homeassistant.components.bme680
# bme680==1.0.5 # bme680==1.0.5

1
script/gen_requirements_all.py
View file

@ -19,6 +19,7 @@ COMMENT_REQUIREMENTS = (
"beewi_smartclim", # depends on bluepy "beewi_smartclim", # depends on bluepy
"blinkt", "blinkt",
"bluepy", "bluepy",
"bme280spi",
"bme680", "bme680",
"decora", "decora",
"decora_wifi", "decora_wifi",