270 lines
9.2 KiB
Python
270 lines
9.2 KiB
Python
"""Bluetti BT sensors."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
from datetime import timedelta
|
|
import logging
|
|
from typing import cast
|
|
import async_timeout
|
|
|
|
from bleak import BleakClient, BleakError
|
|
|
|
from homeassistant.components import bluetooth
|
|
from homeassistant.components.sensor import SensorEntity, CONF_STATE_CLASS
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.const import (
|
|
CONF_ADDRESS,
|
|
CONF_NAME,
|
|
CONF_UNIT_OF_MEASUREMENT,
|
|
CONF_DEVICE_CLASS,
|
|
EntityCategory,
|
|
)
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.entity import DeviceInfo
|
|
from homeassistant.helpers.update_coordinator import (
|
|
CoordinatorEntity,
|
|
DataUpdateCoordinator,
|
|
)
|
|
|
|
from bluetti_mqtt.bluetooth.client import BluetoothClient
|
|
from bluetti_mqtt.bluetooth import (
|
|
BadConnectionError,
|
|
ModbusError,
|
|
ParseError,
|
|
build_device,
|
|
)
|
|
from bluetti_mqtt.mqtt_client import NORMAL_DEVICE_FIELDS
|
|
|
|
from . import device_info as dev_info, get_unique_id
|
|
from .const import (
|
|
API_RESPONSE_BATTERY,
|
|
API_RESPONSE_BATTERY_RANGE_START,
|
|
API_RESPONSE_BATTERY_RANGE_END,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
|
|
) -> None:
|
|
"""Setup sensor entities."""
|
|
|
|
device_name = entry.data.get(CONF_NAME)
|
|
address = entry.data.get(CONF_ADDRESS)
|
|
if address is None:
|
|
_LOGGER.error("Device has no address")
|
|
|
|
# Create coordinator for polling
|
|
coordinator = PollingCoordinator(hass, address, device_name)
|
|
await coordinator.async_config_entry_first_refresh()
|
|
|
|
# Generate device info
|
|
_LOGGER.info("Creating sensors for device with address %s", address)
|
|
device_info = dev_info(entry)
|
|
|
|
# Add sensors according to device_info
|
|
bluetti_device = build_device(address, device_name)
|
|
|
|
sensors_to_add = []
|
|
for field_key, field_config in NORMAL_DEVICE_FIELDS.items():
|
|
if bluetti_device.has_field(field_key):
|
|
category = None
|
|
|
|
if field_key in (
|
|
API_RESPONSE_BATTERY_RANGE_START,
|
|
API_RESPONSE_BATTERY_RANGE_END,
|
|
):
|
|
category = EntityCategory.DIAGNOSTIC
|
|
|
|
sensors_to_add.append(
|
|
BluettiSensor(
|
|
coordinator,
|
|
device_info,
|
|
address,
|
|
field_key,
|
|
field_config.home_assistant_extra.get(CONF_NAME, ""),
|
|
field_config.home_assistant_extra.get(CONF_UNIT_OF_MEASUREMENT, ""),
|
|
field_config.home_assistant_extra.get(CONF_DEVICE_CLASS, ""),
|
|
field_config.home_assistant_extra.get(CONF_STATE_CLASS, ""),
|
|
category,
|
|
)
|
|
)
|
|
|
|
async_add_entities(sensors_to_add)
|
|
|
|
|
|
class PollingCoordinator(DataUpdateCoordinator):
|
|
"""Polling coordinator."""
|
|
|
|
def __init__(self, hass: HomeAssistant, address, device_name: str):
|
|
"""Initialize coordinator."""
|
|
super().__init__(
|
|
hass,
|
|
_LOGGER,
|
|
name="Bluetti polling coordinator",
|
|
update_interval=timedelta(seconds=20),
|
|
)
|
|
self._address = address
|
|
self.notify_future = None
|
|
self.current_command = None
|
|
self.notify_response = bytearray()
|
|
self.bluetti_device = build_device(address, device_name)
|
|
|
|
async def _async_update_data(self):
|
|
"""Fetch data from API endpoint.
|
|
|
|
This is the place to pre-process the data to lookup tables
|
|
so entities can quickly look up their data.
|
|
"""
|
|
self.logger.debug("Polling data")
|
|
|
|
device = bluetooth.async_ble_device_from_address(self.hass, self._address)
|
|
if device is None:
|
|
self.logger.error("Device not available")
|
|
return None
|
|
|
|
if self.bluetti_device is None:
|
|
self.logger.error("Device type not found")
|
|
return None
|
|
|
|
# Polling
|
|
client = BleakClient(device)
|
|
parsed_data: dict = {}
|
|
|
|
try:
|
|
async with async_timeout.timeout(15):
|
|
await client.connect()
|
|
|
|
await client.start_notify(
|
|
BluetoothClient.NOTIFY_UUID, self._notification_handler
|
|
)
|
|
|
|
for command in self.bluetti_device.polling_commands:
|
|
try:
|
|
# Prepare to make request
|
|
self.current_command = command
|
|
self.notify_future = self.hass.loop.create_future()
|
|
self.notify_response = bytearray()
|
|
|
|
# Make request
|
|
self.logger.debug("Requesting %s", command)
|
|
await client.write_gatt_char(
|
|
BluetoothClient.WRITE_UUID, bytes(command)
|
|
)
|
|
|
|
# Wait for response
|
|
res = await asyncio.wait_for(
|
|
self.notify_future, timeout=BluetoothClient.RESPONSE_TIMEOUT
|
|
)
|
|
|
|
# Process data
|
|
self.logger.debug("Got %s bytes", len(res))
|
|
response = cast(bytes, res)
|
|
body = command.parse_response(response)
|
|
parsed = self.bluetti_device.parse(
|
|
command.starting_address, body
|
|
)
|
|
|
|
self.logger.warning("Parsed data: %s", parsed)
|
|
parsed_data.update(parsed)
|
|
|
|
except TimeoutError:
|
|
self.logger.error("Polling timed out")
|
|
except ParseError:
|
|
self.logger.debug("Got a parse exception...")
|
|
except ModbusError as err:
|
|
self.logger.debug(
|
|
"Got an invalid request error for %s: %s",
|
|
command,
|
|
err,
|
|
)
|
|
except (BadConnectionError, BleakError) as err:
|
|
self.logger.debug("Needed to disconnect due to error: %s", err)
|
|
except TimeoutError:
|
|
self.logger.error("Polling timed out")
|
|
return None
|
|
except BleakError as err:
|
|
self.logger.error("Bleak error: %s", err)
|
|
return None
|
|
finally:
|
|
await client.disconnect()
|
|
|
|
# Pass data back to sensors
|
|
return parsed_data
|
|
|
|
def _notification_handler(self, _sender: int, data: bytearray):
|
|
"""Handle bt data."""
|
|
|
|
# Ignore notifications we don't expect
|
|
if not self.notify_future or self.notify_future.done():
|
|
return
|
|
|
|
# If something went wrong, we might get weird data.
|
|
if data == b"AT+NAME?\r" or data == b"AT+ADV?\r":
|
|
err = BadConnectionError("Got AT+ notification")
|
|
self.notify_future.set_exception(err)
|
|
return
|
|
|
|
# Save data
|
|
self.notify_response.extend(data)
|
|
|
|
if len(self.notify_response) == self.current_command.response_size():
|
|
if self.current_command.is_valid_response(self.notify_response):
|
|
self.notify_future.set_result(self.notify_response)
|
|
else:
|
|
self.notify_future.set_exception(ParseError("Failed checksum"))
|
|
elif self.current_command.is_exception_response(self.notify_response):
|
|
# We got a MODBUS command exception
|
|
msg = f"MODBUS Exception {self.current_command}: {self.notify_response[2]}"
|
|
self.notify_future.set_exception(ModbusError(msg))
|
|
|
|
|
|
class BluettiSensor(CoordinatorEntity, SensorEntity):
|
|
"""Bluetti universal sensor."""
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: PollingCoordinator,
|
|
device_info: DeviceInfo,
|
|
address,
|
|
response_key: str,
|
|
name: str,
|
|
unit_of_measurement: str,
|
|
device_class: str,
|
|
state_class: str,
|
|
category: EntityCategory | None = None,
|
|
):
|
|
"""Init battery entity."""
|
|
super().__init__(coordinator)
|
|
|
|
e_name = f"{device_info.get('name')} {name}"
|
|
self._address = address
|
|
self._response_key = response_key
|
|
|
|
self._attr_device_info = device_info
|
|
self._attr_name = e_name
|
|
self._attr_unique_id = get_unique_id(e_name)
|
|
self._attr_native_unit_of_measurement = unit_of_measurement
|
|
self._attr_device_class = device_class
|
|
self._attr_state_class = state_class
|
|
self._attr_entity_category = category
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
if self._address is None:
|
|
return False
|
|
return bluetooth.async_address_present(self.hass, self._address)
|
|
|
|
@callback
|
|
def _handle_coordinator_update(self) -> None:
|
|
"""Handle updated data from the coordinator."""
|
|
_LOGGER.debug("Updating state of %s", self._attr_unique_id)
|
|
if not isinstance(self.coordinator.data, dict):
|
|
_LOGGER.error("Invalid data from coordinator")
|
|
return
|
|
self._attr_native_value = self.coordinator.data[self._response_key]
|
|
self.async_write_ha_state()
|