Home Assistant Unofficial Reference 2024.12.1
sensor.py
Go to the documentation of this file.
1 """Common functions related to sensor device management."""
2 
3 from __future__ import annotations
4 
5 from typing import TYPE_CHECKING
6 
7 from homeassistant import const
8 
9 from .device_registry import DeviceInfo
10 
11 if TYPE_CHECKING:
12  # `sensor_state_data` is a second-party library (i.e. maintained by Home Assistant
13  # core members) which is not strictly required by Home Assistant.
14  # Therefore, we import it as a type hint only.
15  from sensor_state_data import SensorDeviceInfo
16 
17 
19  sensor_device_info: SensorDeviceInfo,
20 ) -> DeviceInfo:
21  """Convert a sensor_state_data sensor device info to a HA device info."""
22  device_info = DeviceInfo()
23  if sensor_device_info.name is not None:
24  device_info[const.ATTR_NAME] = sensor_device_info.name
25  if sensor_device_info.manufacturer is not None:
26  device_info[const.ATTR_MANUFACTURER] = sensor_device_info.manufacturer
27  if sensor_device_info.model is not None:
28  device_info[const.ATTR_MODEL] = sensor_device_info.model
29  return device_info
DeviceInfo sensor_device_info_to_hass_device_info(SensorDeviceInfo sensor_device_info)
Definition: sensor.py:20