mirror of https://github.com/home-assistant/core
150 lines
3.9 KiB
Python
150 lines
3.9 KiB
Python
"""Support for Ubiquiti mFi sensors."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
|
|
from mficlient.client import FailedToLogin, MFiClient
|
|
import requests
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import (
|
|
PLATFORM_SCHEMA as SENSOR_PLATFORM_SCHEMA,
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_HOST,
|
|
CONF_PASSWORD,
|
|
CONF_PORT,
|
|
CONF_SSL,
|
|
CONF_USERNAME,
|
|
CONF_VERIFY_SSL,
|
|
STATE_OFF,
|
|
STATE_ON,
|
|
UnitOfTemperature,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEFAULT_SSL = True
|
|
DEFAULT_VERIFY_SSL = True
|
|
|
|
DIGITS = {"volts": 1, "amps": 1, "active_power": 0, "temperature": 1}
|
|
|
|
SENSOR_MODELS = [
|
|
"Ubiquiti mFi-THS",
|
|
"Ubiquiti mFi-CS",
|
|
"Ubiquiti mFi-DS",
|
|
"Outlet",
|
|
"Input Analog",
|
|
"Input Digital",
|
|
]
|
|
|
|
PLATFORM_SCHEMA = SENSOR_PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Required(CONF_PASSWORD): cv.string,
|
|
vol.Optional(CONF_PORT): cv.port,
|
|
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
|
|
vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
|
|
}
|
|
)
|
|
|
|
|
|
def setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up mFi sensors."""
|
|
host = config.get(CONF_HOST)
|
|
username = config.get(CONF_USERNAME)
|
|
password = config.get(CONF_PASSWORD)
|
|
use_tls = config.get(CONF_SSL)
|
|
verify_tls = config.get(CONF_VERIFY_SSL)
|
|
default_port = 6443 if use_tls else 6080
|
|
port = int(config.get(CONF_PORT, default_port))
|
|
|
|
try:
|
|
client = MFiClient(
|
|
host, username, password, port=port, use_tls=use_tls, verify=verify_tls
|
|
)
|
|
except (FailedToLogin, requests.exceptions.ConnectionError) as ex:
|
|
_LOGGER.error("Unable to connect to mFi: %s", str(ex))
|
|
return
|
|
|
|
add_entities(
|
|
MfiSensor(port, hass)
|
|
for device in client.get_devices()
|
|
for port in device.ports.values()
|
|
if port.model in SENSOR_MODELS
|
|
)
|
|
|
|
|
|
class MfiSensor(SensorEntity):
|
|
"""Representation of a mFi sensor."""
|
|
|
|
def __init__(self, port, hass):
|
|
"""Initialize the sensor."""
|
|
self._port = port
|
|
self._hass = hass
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._port.label
|
|
|
|
@property
|
|
def native_value(self):
|
|
"""Return the state of the sensor."""
|
|
try:
|
|
tag = self._port.tag
|
|
except ValueError:
|
|
tag = None
|
|
if tag is None:
|
|
return STATE_OFF
|
|
if self._port.model == "Input Digital":
|
|
return STATE_ON if self._port.value > 0 else STATE_OFF
|
|
digits = DIGITS.get(self._port.tag, 0)
|
|
return round(self._port.value, digits)
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the device class of the sensor."""
|
|
try:
|
|
tag = self._port.tag
|
|
except ValueError:
|
|
return None
|
|
|
|
if tag == "temperature":
|
|
return SensorDeviceClass.TEMPERATURE
|
|
|
|
return None
|
|
|
|
@property
|
|
def native_unit_of_measurement(self):
|
|
"""Return the unit of measurement of this entity, if any."""
|
|
try:
|
|
tag = self._port.tag
|
|
except ValueError:
|
|
return None
|
|
|
|
if tag == "temperature":
|
|
return UnitOfTemperature.CELSIUS
|
|
if tag == "active_pwr":
|
|
return "Watts"
|
|
if self._port.model == "Input Digital":
|
|
return None
|
|
return tag
|
|
|
|
def update(self) -> None:
|
|
"""Get the latest data."""
|
|
self._port.refresh()
|