diff --git a/CODEOWNERS b/CODEOWNERS index 2a3999779fc..792a6302b79 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -498,6 +498,8 @@ build.json @home-assistant/supervisor /homeassistant/components/incomfort/ @zxdavb /homeassistant/components/influxdb/ @mdegat01 /tests/components/influxdb/ @mdegat01 +/homeassistant/components/inkbird/ @bdraco +/tests/components/inkbird/ @bdraco /homeassistant/components/input_boolean/ @home-assistant/core /tests/components/input_boolean/ @home-assistant/core /homeassistant/components/input_button/ @home-assistant/core diff --git a/homeassistant/components/inkbird/__init__.py b/homeassistant/components/inkbird/__init__.py new file mode 100644 index 00000000000..29b63e34263 --- /dev/null +++ b/homeassistant/components/inkbird/__init__.py @@ -0,0 +1,56 @@ +"""The INKBIRD Bluetooth integration.""" +from __future__ import annotations + +import logging + +from inkbird_ble import INKBIRDBluetoothDeviceData + +from homeassistant.components.bluetooth.passive_update_coordinator import ( + PassiveBluetoothDataUpdate, + PassiveBluetoothDataUpdateCoordinator, +) +from homeassistant.config_entries import ConfigEntry +from homeassistant.const import Platform +from homeassistant.core import HomeAssistant, callback +from homeassistant.helpers.service_info.bluetooth import BluetoothServiceInfo + +from .const import DOMAIN +from .sensor import sensor_update_to_bluetooth_data_update + +PLATFORMS: list[Platform] = [Platform.SENSOR] + +_LOGGER = logging.getLogger(__name__) + + +async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: + """Set up INKBIRD BLE device from a config entry.""" + address = entry.unique_id + assert address is not None + + data = INKBIRDBluetoothDeviceData() + + @callback + def _async_update_data( + service_info: BluetoothServiceInfo, + ) -> PassiveBluetoothDataUpdate: + """Update data from INKBIRD Bluetooth.""" + return sensor_update_to_bluetooth_data_update(data.update(service_info)) + + hass.data.setdefault(DOMAIN, {})[ + entry.entry_id + ] = PassiveBluetoothDataUpdateCoordinator( + hass, + _LOGGER, + update_method=_async_update_data, + address=address, + ) + await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS) + return True + + +async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: + """Unload a config entry.""" + if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS): + hass.data[DOMAIN].pop(entry.entry_id) + + return unload_ok diff --git a/homeassistant/components/inkbird/config_flow.py b/homeassistant/components/inkbird/config_flow.py new file mode 100644 index 00000000000..679ff43b19e --- /dev/null +++ b/homeassistant/components/inkbird/config_flow.py @@ -0,0 +1,93 @@ +"""Config flow for inkbird ble integration.""" +from __future__ import annotations + +from typing import Any + +from inkbird_ble import INKBIRDBluetoothDeviceData as DeviceData +import voluptuous as vol + +from homeassistant.components.bluetooth import ( + BluetoothServiceInfo, + async_discovered_service_info, +) +from homeassistant.config_entries import ConfigFlow +from homeassistant.const import CONF_ADDRESS +from homeassistant.data_entry_flow import FlowResult + +from .const import DOMAIN + + +class INKBIRDConfigFlow(ConfigFlow, domain=DOMAIN): + """Handle a config flow for inkbird.""" + + VERSION = 1 + + def __init__(self) -> None: + """Initialize the config flow.""" + self._discovery_info: BluetoothServiceInfo | None = None + self._discovered_device: DeviceData | None = None + self._discovered_devices: dict[str, str] = {} + + async def async_step_bluetooth( + self, discovery_info: BluetoothServiceInfo + ) -> FlowResult: + """Handle the bluetooth discovery step.""" + await self.async_set_unique_id(discovery_info.address) + self._abort_if_unique_id_configured() + device = DeviceData() + if not device.supported(discovery_info): + return self.async_abort(reason="not_supported") + self._discovery_info = discovery_info + self._discovered_device = device + return await self.async_step_bluetooth_confirm() + + async def async_step_bluetooth_confirm( + self, user_input: dict[str, Any] | None = None + ) -> FlowResult: + """Confirm discovery.""" + assert self._discovered_device is not None + device = self._discovered_device + assert self._discovery_info is not None + discovery_info = self._discovery_info + title = device.title or device.get_device_name() or discovery_info.name + if user_input is not None: + return self.async_create_entry(title=title, data={}) + + self._set_confirm_only() + placeholders = {"name": title} + self.context["title_placeholders"] = placeholders + return self.async_show_form( + step_id="bluetooth_confirm", description_placeholders=placeholders + ) + + async def async_step_user( + self, user_input: dict[str, Any] | None = None + ) -> FlowResult: + """Handle the user step to pick discovered device.""" + if user_input is not None: + address = user_input[CONF_ADDRESS] + await self.async_set_unique_id(address, raise_on_progress=False) + return self.async_create_entry( + title=self._discovered_devices[address], data={} + ) + + current_addresses = self._async_current_ids() + for discovery_info in async_discovered_service_info(self.hass): + address = discovery_info.address + if address in current_addresses or address in self._discovered_devices: + continue + device = DeviceData() + if device.supported(discovery_info): + self._discovered_devices[address] = ( + device.title or device.get_device_name() or discovery_info.name + ) + + if not self._discovered_devices: + return self.async_abort(reason="no_devices_found") + + return self.async_show_form( + step_id="user", + data_schema=vol.Schema( + {vol.Required(CONF_ADDRESS): vol.In(self._discovered_devices)} + ), + ) diff --git a/homeassistant/components/inkbird/const.py b/homeassistant/components/inkbird/const.py new file mode 100644 index 00000000000..9d0e1638958 --- /dev/null +++ b/homeassistant/components/inkbird/const.py @@ -0,0 +1,3 @@ +"""Constants for the INKBIRD Bluetooth integration.""" + +DOMAIN = "inkbird" diff --git a/homeassistant/components/inkbird/manifest.json b/homeassistant/components/inkbird/manifest.json new file mode 100644 index 00000000000..686c9bada2d --- /dev/null +++ b/homeassistant/components/inkbird/manifest.json @@ -0,0 +1,16 @@ +{ + "domain": "inkbird", + "name": "INKBIRD", + "config_flow": true, + "documentation": "https://www.home-assistant.io/integrations/inkbird", + "bluetooth": [ + { "local_name": "sps" }, + { "local_name": "Inkbird*" }, + { "local_name": "iBBQ*" }, + { "local_name": "tps" } + ], + "requirements": ["inkbird-ble==0.5.1"], + "dependencies": ["bluetooth"], + "codeowners": ["@bdraco"], + "iot_class": "local_push" +} diff --git a/homeassistant/components/inkbird/sensor.py b/homeassistant/components/inkbird/sensor.py new file mode 100644 index 00000000000..26311131181 --- /dev/null +++ b/homeassistant/components/inkbird/sensor.py @@ -0,0 +1,142 @@ +"""Support for inkbird ble sensors.""" +from __future__ import annotations + +from typing import Optional, Union + +from inkbird_ble import DeviceClass, DeviceKey, SensorDeviceInfo, SensorUpdate, Units + +from homeassistant import config_entries +from homeassistant.components.bluetooth.passive_update_coordinator import ( + PassiveBluetoothCoordinatorEntity, + PassiveBluetoothDataUpdate, + PassiveBluetoothDataUpdateCoordinator, + PassiveBluetoothEntityKey, +) +from homeassistant.components.sensor import ( + SensorDeviceClass, + SensorEntity, + SensorEntityDescription, + SensorStateClass, +) +from homeassistant.const import ( + ATTR_MANUFACTURER, + ATTR_MODEL, + ATTR_NAME, + PERCENTAGE, + SIGNAL_STRENGTH_DECIBELS_MILLIWATT, + TEMP_CELSIUS, +) +from homeassistant.core import HomeAssistant +from homeassistant.helpers.entity import DeviceInfo +from homeassistant.helpers.entity_platform import AddEntitiesCallback + +from .const import DOMAIN + +SENSOR_DESCRIPTIONS = { + (DeviceClass.TEMPERATURE, Units.TEMP_CELSIUS): SensorEntityDescription( + key=f"{DeviceClass.TEMPERATURE}_{Units.TEMP_CELSIUS}", + device_class=SensorDeviceClass.TEMPERATURE, + native_unit_of_measurement=TEMP_CELSIUS, + state_class=SensorStateClass.MEASUREMENT, + ), + (DeviceClass.HUMIDITY, Units.PERCENTAGE): SensorEntityDescription( + key=f"{DeviceClass.HUMIDITY}_{Units.PERCENTAGE}", + device_class=SensorDeviceClass.HUMIDITY, + native_unit_of_measurement=PERCENTAGE, + state_class=SensorStateClass.MEASUREMENT, + ), + (DeviceClass.BATTERY, Units.PERCENTAGE): SensorEntityDescription( + key=f"{DeviceClass.BATTERY}_{Units.PERCENTAGE}", + device_class=SensorDeviceClass.BATTERY, + native_unit_of_measurement=PERCENTAGE, + state_class=SensorStateClass.MEASUREMENT, + ), + ( + DeviceClass.SIGNAL_STRENGTH, + Units.SIGNAL_STRENGTH_DECIBELS_MILLIWATT, + ): SensorEntityDescription( + key=f"{DeviceClass.SIGNAL_STRENGTH}_{Units.SIGNAL_STRENGTH_DECIBELS_MILLIWATT}", + device_class=SensorDeviceClass.SIGNAL_STRENGTH, + native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT, + state_class=SensorStateClass.MEASUREMENT, + entity_registry_enabled_default=False, + ), +} + + +def _device_key_to_bluetooth_entity_key( + device_key: DeviceKey, +) -> PassiveBluetoothEntityKey: + """Convert a device key to an entity key.""" + return PassiveBluetoothEntityKey(device_key.key, device_key.device_id) + + +def _sensor_device_info_to_hass( + sensor_device_info: SensorDeviceInfo, +) -> DeviceInfo: + """Convert a sensor device info to a sensor device info.""" + hass_device_info = DeviceInfo({}) + if sensor_device_info.name is not None: + hass_device_info[ATTR_NAME] = sensor_device_info.name + if sensor_device_info.manufacturer is not None: + hass_device_info[ATTR_MANUFACTURER] = sensor_device_info.manufacturer + if sensor_device_info.model is not None: + hass_device_info[ATTR_MODEL] = sensor_device_info.model + return hass_device_info + + +def sensor_update_to_bluetooth_data_update( + sensor_update: SensorUpdate, +) -> PassiveBluetoothDataUpdate: + """Convert a sensor update to a bluetooth data update.""" + return PassiveBluetoothDataUpdate( + devices={ + device_id: _sensor_device_info_to_hass(device_info) + for device_id, device_info in sensor_update.devices.items() + }, + entity_descriptions={ + _device_key_to_bluetooth_entity_key(device_key): SENSOR_DESCRIPTIONS[ + (description.device_class, description.native_unit_of_measurement) + ] + for device_key, description in sensor_update.entity_descriptions.items() + if description.device_class and description.native_unit_of_measurement + }, + entity_data={ + _device_key_to_bluetooth_entity_key(device_key): sensor_values.native_value + for device_key, sensor_values in sensor_update.entity_values.items() + }, + entity_names={ + _device_key_to_bluetooth_entity_key(device_key): sensor_values.name + for device_key, sensor_values in sensor_update.entity_values.items() + }, + ) + + +async def async_setup_entry( + hass: HomeAssistant, + entry: config_entries.ConfigEntry, + async_add_entities: AddEntitiesCallback, +) -> None: + """Set up the INKBIRD BLE sensors.""" + coordinator: PassiveBluetoothDataUpdateCoordinator = hass.data[DOMAIN][ + entry.entry_id + ] + entry.async_on_unload( + coordinator.async_add_entities_listener( + INKBIRDBluetoothSensorEntity, async_add_entities + ) + ) + + +class INKBIRDBluetoothSensorEntity( + PassiveBluetoothCoordinatorEntity[ + PassiveBluetoothDataUpdateCoordinator[Optional[Union[float, int]]] + ], + SensorEntity, +): + """Representation of a inkbird ble sensor.""" + + @property + def native_value(self) -> int | float | None: + """Return the native value.""" + return self.coordinator.entity_data.get(self.entity_key) diff --git a/homeassistant/components/inkbird/strings.json b/homeassistant/components/inkbird/strings.json new file mode 100644 index 00000000000..7111626cca1 --- /dev/null +++ b/homeassistant/components/inkbird/strings.json @@ -0,0 +1,21 @@ +{ + "config": { + "flow_title": "[%key:component::bluetooth::config::flow_title%]", + "step": { + "user": { + "description": "[%key:component::bluetooth::config::step::user::description%]", + "data": { + "address": "[%key:component::bluetooth::config::step::user::data::address%]" + } + }, + "bluetooth_confirm": { + "description": "[%key:component::bluetooth::config::step::bluetooth_confirm::description%]" + } + }, + "abort": { + "no_devices_found": "[%key:common::config_flow::abort::no_devices_found%]", + "already_in_progress": "[%key:common::config_flow::abort::already_in_progress%]", + "already_configured": "[%key:common::config_flow::abort::already_configured_device%]" + } + } +} diff --git a/homeassistant/components/inkbird/translations/en.json b/homeassistant/components/inkbird/translations/en.json new file mode 100644 index 00000000000..d24df64f135 --- /dev/null +++ b/homeassistant/components/inkbird/translations/en.json @@ -0,0 +1,21 @@ +{ + "config": { + "abort": { + "already_configured": "Device is already configured", + "already_in_progress": "Configuration flow is already in progress", + "no_devices_found": "No devices found on the network" + }, + "flow_title": "{name}", + "step": { + "bluetooth_confirm": { + "description": "Do you want to setup {name}?" + }, + "user": { + "data": { + "address": "Device" + }, + "description": "Choose a device to setup" + } + } + } +} \ No newline at end of file diff --git a/homeassistant/generated/bluetooth.py b/homeassistant/generated/bluetooth.py index e3a4edc11d4..1edd25a7609 100644 --- a/homeassistant/generated/bluetooth.py +++ b/homeassistant/generated/bluetooth.py @@ -14,6 +14,22 @@ BLUETOOTH: list[dict[str, str | int | list[int]]] = [ 6 ] }, + { + "domain": "inkbird", + "local_name": "sps" + }, + { + "domain": "inkbird", + "local_name": "Inkbird*" + }, + { + "domain": "inkbird", + "local_name": "iBBQ*" + }, + { + "domain": "inkbird", + "local_name": "tps" + }, { "domain": "sensorpush", "local_name": "SensorPush*" diff --git a/homeassistant/generated/config_flows.py b/homeassistant/generated/config_flows.py index 95050ea6dbd..33e34035b34 100644 --- a/homeassistant/generated/config_flows.py +++ b/homeassistant/generated/config_flows.py @@ -166,6 +166,7 @@ FLOWS = { "iaqualink", "icloud", "ifttt", + "inkbird", "insteon", "intellifire", "ios", diff --git a/requirements_all.txt b/requirements_all.txt index f125a49c0a4..0b3c0e4b370 100644 --- a/requirements_all.txt +++ b/requirements_all.txt @@ -896,6 +896,9 @@ influxdb-client==1.24.0 # homeassistant.components.influxdb influxdb==5.3.1 +# homeassistant.components.inkbird +inkbird-ble==0.5.1 + # homeassistant.components.insteon insteon-frontend-home-assistant==0.2.0 diff --git a/requirements_test_all.txt b/requirements_test_all.txt index 605eb8352ea..53f1689e476 100644 --- a/requirements_test_all.txt +++ b/requirements_test_all.txt @@ -648,6 +648,9 @@ influxdb-client==1.24.0 # homeassistant.components.influxdb influxdb==5.3.1 +# homeassistant.components.inkbird +inkbird-ble==0.5.1 + # homeassistant.components.insteon insteon-frontend-home-assistant==0.2.0 diff --git a/tests/components/inkbird/__init__.py b/tests/components/inkbird/__init__.py new file mode 100644 index 00000000000..0a74e50ae0e --- /dev/null +++ b/tests/components/inkbird/__init__.py @@ -0,0 +1,36 @@ +"""Tests for the INKBIRD integration.""" + + +from homeassistant.helpers.service_info.bluetooth import BluetoothServiceInfo + +NOT_INKBIRD_SERVICE_INFO = BluetoothServiceInfo( + name="Not it", + address="61DE521B-F0BF-9F44-64D4-75BBE1738105", + rssi=-63, + manufacturer_data={3234: b"\x00\x01"}, + service_data={}, + service_uuids=[], + source="local", +) + +SPS_SERVICE_INFO = BluetoothServiceInfo( + name="sps", + address="61DE521B-F0BF-9F44-64D4-75BBE1738105", + rssi=-63, + service_data={}, + manufacturer_data={2096: b"\x0f\x12\x00Z\xc7W\x06"}, + service_uuids=["0000fff0-0000-1000-8000-00805f9b34fb"], + source="local", +) + +IBBQ_SERVICE_INFO = BluetoothServiceInfo( + name="iBBQ", + address="4125DDBA-2774-4851-9889-6AADDD4CAC3D", + rssi=-56, + manufacturer_data={ + 0: b"\x00\x000\xe2\x83}\xb5\x02\xc8\x00\xc8\x00\xc8\x00\xc8\x00" + }, + service_uuids=["0000fff0-0000-1000-8000-00805f9b34fb"], + service_data={}, + source="local", +) diff --git a/tests/components/inkbird/conftest.py b/tests/components/inkbird/conftest.py new file mode 100644 index 00000000000..c44e9f7929a --- /dev/null +++ b/tests/components/inkbird/conftest.py @@ -0,0 +1,8 @@ +"""INKBIRD session fixtures.""" + +import pytest + + +@pytest.fixture(autouse=True) +def mock_bluetooth(mock_bleak_scanner_start): + """Auto mock bluetooth.""" diff --git a/tests/components/inkbird/test_config_flow.py b/tests/components/inkbird/test_config_flow.py new file mode 100644 index 00000000000..b783562b126 --- /dev/null +++ b/tests/components/inkbird/test_config_flow.py @@ -0,0 +1,94 @@ +"""Test the INKBIRD config flow.""" + +from unittest.mock import patch + +from homeassistant import config_entries +from homeassistant.components.inkbird.const import DOMAIN +from homeassistant.data_entry_flow import FlowResultType + +from . import IBBQ_SERVICE_INFO, NOT_INKBIRD_SERVICE_INFO, SPS_SERVICE_INFO + +from tests.common import MockConfigEntry + + +async def test_async_step_bluetooth_valid_device(hass): + """Test discovery via bluetooth with a valid device.""" + result = await hass.config_entries.flow.async_init( + DOMAIN, + context={"source": config_entries.SOURCE_BLUETOOTH}, + data=IBBQ_SERVICE_INFO, + ) + assert result["type"] == FlowResultType.FORM + assert result["step_id"] == "bluetooth_confirm" + with patch("homeassistant.components.inkbird.async_setup_entry", return_value=True): + result2 = await hass.config_entries.flow.async_configure( + result["flow_id"], user_input={} + ) + assert result2["type"] == FlowResultType.CREATE_ENTRY + assert result2["title"] == "iBBQ 6AADDD4CAC3D" + assert result2["data"] == {} + assert result2["result"].unique_id == "4125DDBA-2774-4851-9889-6AADDD4CAC3D" + + +async def test_async_step_bluetooth_not_inkbird(hass): + """Test discovery via bluetooth not inkbird.""" + result = await hass.config_entries.flow.async_init( + DOMAIN, + context={"source": config_entries.SOURCE_BLUETOOTH}, + data=NOT_INKBIRD_SERVICE_INFO, + ) + assert result["type"] == FlowResultType.ABORT + assert result["reason"] == "not_supported" + + +async def test_async_step_user_no_devices_found(hass): + """Test setup from service info cache with no devices found.""" + result = await hass.config_entries.flow.async_init( + DOMAIN, + context={"source": config_entries.SOURCE_USER}, + ) + assert result["type"] == FlowResultType.ABORT + assert result["reason"] == "no_devices_found" + + +async def test_async_step_user_with_found_devices(hass): + """Test setup from service info cache with devices found.""" + with patch( + "homeassistant.components.inkbird.config_flow.async_discovered_service_info", + return_value=[SPS_SERVICE_INFO], + ): + result = await hass.config_entries.flow.async_init( + DOMAIN, + context={"source": config_entries.SOURCE_USER}, + ) + assert result["type"] == FlowResultType.FORM + assert result["step_id"] == "user" + with patch("homeassistant.components.inkbird.async_setup_entry", return_value=True): + result2 = await hass.config_entries.flow.async_configure( + result["flow_id"], + user_input={"address": "61DE521B-F0BF-9F44-64D4-75BBE1738105"}, + ) + assert result2["type"] == FlowResultType.CREATE_ENTRY + assert result2["title"] == "IBS-TH 75BBE1738105" + assert result2["data"] == {} + assert result2["result"].unique_id == "61DE521B-F0BF-9F44-64D4-75BBE1738105" + + +async def test_async_step_user_with_found_devices_already_setup(hass): + """Test setup from service info cache with devices found.""" + entry = MockConfigEntry( + domain=DOMAIN, + unique_id="61DE521B-F0BF-9F44-64D4-75BBE1738105", + ) + entry.add_to_hass(hass) + + with patch( + "homeassistant.components.inkbird.config_flow.async_discovered_service_info", + return_value=[SPS_SERVICE_INFO], + ): + result = await hass.config_entries.flow.async_init( + DOMAIN, + context={"source": config_entries.SOURCE_USER}, + ) + assert result["type"] == FlowResultType.ABORT + assert result["reason"] == "no_devices_found" diff --git a/tests/components/inkbird/test_sensor.py b/tests/components/inkbird/test_sensor.py new file mode 100644 index 00000000000..80a2179666f --- /dev/null +++ b/tests/components/inkbird/test_sensor.py @@ -0,0 +1,50 @@ +"""Test the INKBIRD config flow.""" + +from unittest.mock import patch + +from homeassistant.components.bluetooth import BluetoothChange +from homeassistant.components.inkbird.const import DOMAIN +from homeassistant.components.sensor import ATTR_STATE_CLASS +from homeassistant.const import ATTR_FRIENDLY_NAME, ATTR_UNIT_OF_MEASUREMENT + +from . import SPS_SERVICE_INFO + +from tests.common import MockConfigEntry + + +async def test_sensors(hass): + """Test setting up creates the sensors.""" + entry = MockConfigEntry( + domain=DOMAIN, + unique_id="61DE521B-F0BF-9F44-64D4-75BBE1738105", + ) + entry.add_to_hass(hass) + + saved_callback = None + + def _async_register_callback(_hass, _callback, _matcher): + nonlocal saved_callback + saved_callback = _callback + return lambda: None + + with patch( + "homeassistant.components.bluetooth.passive_update_coordinator.async_register_callback", + _async_register_callback, + ): + assert await hass.config_entries.async_setup(entry.entry_id) + await hass.async_block_till_done() + + assert len(hass.states.async_all()) == 0 + saved_callback(SPS_SERVICE_INFO, BluetoothChange.ADVERTISEMENT) + await hass.async_block_till_done() + assert len(hass.states.async_all()) == 3 + + temp_sensor = hass.states.get("sensor.ibs_th_75bbe1738105_battery") + temp_sensor_attribtes = temp_sensor.attributes + assert temp_sensor.state == "87" + assert temp_sensor_attribtes[ATTR_FRIENDLY_NAME] == "IBS-TH 75BBE1738105 Battery" + assert temp_sensor_attribtes[ATTR_UNIT_OF_MEASUREMENT] == "%" + assert temp_sensor_attribtes[ATTR_STATE_CLASS] == "measurement" + + assert await hass.config_entries.async_unload(entry.entry_id) + await hass.async_block_till_done()