mirror of
https://github.com/tomaae/homeassistant-mikrotik_router.git
synced 2025-07-14 11:24:31 +02:00
coordinator update
This commit is contained in:
Tomaae
parent
ce9ce906f5
commit
a21e95c36a
14 changed files with 445 additions and 496 deletions
309
custom_components/mikrotik_router/entity.py
Normal file
309
custom_components/mikrotik_router/entity.py
Normal file
|
|
@ -0,0 +1,309 @@
|
|||
"""Mikrotik HA shared entity model"""
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Mapping
|
||||
from logging import getLogger
|
||||
from typing import Any, Callable
|
||||
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import ATTR_ATTRIBUTION, CONF_NAME, CONF_HOST
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.helpers import (
|
||||
entity_platform as ep,
|
||||
entity_registry as er,
|
||||
)
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||
from homeassistant.helpers.entity import DeviceInfo, Entity
|
||||
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
||||
from homeassistant.util import slugify
|
||||
|
||||
from .const import (
|
||||
DOMAIN,
|
||||
ATTRIBUTION,
|
||||
CONF_SENSOR_PORT_TRAFFIC,
|
||||
DEFAULT_SENSOR_PORT_TRAFFIC,
|
||||
CONF_TRACK_HOSTS,
|
||||
DEFAULT_TRACK_HOSTS,
|
||||
CONF_SENSOR_PORT_TRACKER,
|
||||
DEFAULT_SENSOR_PORT_TRACKER,
|
||||
)
|
||||
from .coordinator import MikrotikCoordinator
|
||||
from .helper import format_attribute
|
||||
|
||||
_LOGGER = getLogger(__name__)
|
||||
|
||||
|
||||
def _skip_sensor(config_entry, entity_description, data, uid) -> bool:
|
||||
# Sensors
|
||||
if (
|
||||
entity_description.func == "MikrotikInterfaceTrafficSensor"
|
||||
and not config_entry.options.get(
|
||||
CONF_SENSOR_PORT_TRAFFIC, DEFAULT_SENSOR_PORT_TRAFFIC
|
||||
)
|
||||
):
|
||||
return True
|
||||
|
||||
if (
|
||||
entity_description.func == "MikrotikInterfaceTrafficSensor"
|
||||
and data[uid]["type"] == "bridge"
|
||||
):
|
||||
return True
|
||||
|
||||
if (
|
||||
entity_description.func == "MikrotikClientTrafficSensor"
|
||||
and entity_description.data_attribute not in data[uid].keys()
|
||||
):
|
||||
return True
|
||||
|
||||
# Binary sensors
|
||||
if (
|
||||
entity_description.func == "MikrotikPortBinarySensor"
|
||||
and data[uid]["type"] == "wlan"
|
||||
):
|
||||
return True
|
||||
|
||||
if (
|
||||
entity_description.func == "MikrotikPortBinarySensor"
|
||||
and not config_entry.options.get(
|
||||
CONF_SENSOR_PORT_TRACKER, DEFAULT_SENSOR_PORT_TRACKER
|
||||
)
|
||||
):
|
||||
return True
|
||||
|
||||
# Device Tracker
|
||||
if (
|
||||
# Skip if host tracking is disabled
|
||||
entity_description.func == "MikrotikHostDeviceTracker"
|
||||
and not config_entry.options.get(CONF_TRACK_HOSTS, DEFAULT_TRACK_HOSTS)
|
||||
):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
# ---------------------------
|
||||
# async_add_entities
|
||||
# ---------------------------
|
||||
async def async_add_entities(
|
||||
hass: HomeAssistant, config_entry: ConfigEntry, dispatcher: dict[str, Callable]
|
||||
):
|
||||
"""Add entities."""
|
||||
coordinator = hass.data[DOMAIN][config_entry.entry_id]
|
||||
platform = ep.async_get_current_platform()
|
||||
services = platform.platform.SENSOR_SERVICES
|
||||
descriptions = platform.platform.SENSOR_TYPES
|
||||
|
||||
for service in services:
|
||||
platform.async_register_entity_service(service[0], service[1], service[2])
|
||||
|
||||
@callback
|
||||
async def async_update_controller(coordinator):
|
||||
"""Update the values of the controller."""
|
||||
|
||||
async def async_check_exist(obj, coordinator, uid: None) -> None:
|
||||
"""Check entity exists."""
|
||||
entity_registry = er.async_get(hass)
|
||||
if uid:
|
||||
unique_id = f"{obj._inst.lower()}-{obj.entity_description.key}-{slugify(str(obj._data[obj.entity_description.data_reference]).lower())}"
|
||||
else:
|
||||
unique_id = f"{obj._inst.lower()}-{obj.entity_description.key}"
|
||||
|
||||
entity_id = entity_registry.async_get_entity_id(
|
||||
platform.domain, DOMAIN, unique_id
|
||||
)
|
||||
entity = entity_registry.async_get(entity_id)
|
||||
if entity is None or (
|
||||
(entity_id not in platform.entities) and (entity.disabled is False)
|
||||
):
|
||||
_LOGGER.debug("Add entity %s", entity_id)
|
||||
await platform.async_add_entities([obj])
|
||||
|
||||
for entity_description in descriptions:
|
||||
data = coordinator.data[entity_description.data_path]
|
||||
if not entity_description.data_reference:
|
||||
if data.get(entity_description.data_attribute) is None:
|
||||
continue
|
||||
obj = dispatcher[entity_description.func](
|
||||
coordinator, entity_description
|
||||
)
|
||||
await async_check_exist(obj, coordinator, None)
|
||||
else:
|
||||
for uid in data:
|
||||
if _skip_sensor(config_entry, entity_description, data, uid):
|
||||
continue
|
||||
obj = dispatcher[entity_description.func](
|
||||
coordinator, entity_description, uid
|
||||
)
|
||||
await async_check_exist(obj, coordinator, uid)
|
||||
|
||||
await async_update_controller(coordinator)
|
||||
unsub = async_dispatcher_connect(hass, "update_sensors", async_update_controller)
|
||||
config_entry.async_on_unload(unsub)
|
||||
|
||||
|
||||
# ---------------------------
|
||||
# MikrotikEntity
|
||||
# ---------------------------
|
||||
class MikrotikEntity(CoordinatorEntity[MikrotikCoordinator], Entity):
|
||||
"""Define entity"""
|
||||
|
||||
_attr_has_entity_name = True
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
coordinator: MikrotikCoordinator,
|
||||
entity_description,
|
||||
uid: str | None = None,
|
||||
):
|
||||
"""Initialize entity"""
|
||||
super().__init__(coordinator)
|
||||
self.coordinator = coordinator
|
||||
self.entity_description = entity_description
|
||||
self._inst = coordinator.config_entry.data[CONF_NAME]
|
||||
self._config_entry = self.coordinator.config_entry
|
||||
self._attr_extra_state_attributes = {ATTR_ATTRIBUTION: ATTRIBUTION}
|
||||
self._uid = uid
|
||||
self._data = coordinator.data[self.entity_description.data_path]
|
||||
if self._uid:
|
||||
self._data = coordinator.data[self.entity_description.data_path][self._uid]
|
||||
|
||||
@callback
|
||||
def _handle_coordinator_update(self) -> None:
|
||||
self._data = self.coordinator.data[self.entity_description.data_path]
|
||||
if self._uid:
|
||||
self._data = self.coordinator.data[self.entity_description.data_path][
|
||||
self._uid
|
||||
]
|
||||
super()._handle_coordinator_update()
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""Return the name for this entity"""
|
||||
if not self._uid:
|
||||
if self.entity_description.data_name_comment and self._data["comment"]:
|
||||
return f"{self._data['comment']}"
|
||||
|
||||
return f"{self.entity_description.name}"
|
||||
|
||||
if self.entity_description.data_name_comment and self._data["comment"]:
|
||||
return f"{self._data['comment']}"
|
||||
|
||||
if self.entity_description.name:
|
||||
if (
|
||||
self._data[self.entity_description.data_reference]
|
||||
== self._data[self.entity_description.data_name]
|
||||
):
|
||||
return f"{self.entity_description.name}"
|
||||
|
||||
return f"{self._data[self.entity_description.data_name]} {self.entity_description.name}"
|
||||
|
||||
return f"{self._data[self.entity_description.data_name]}"
|
||||
|
||||
@property
|
||||
def unique_id(self) -> str:
|
||||
"""Return a unique id for this entity"""
|
||||
if self._uid:
|
||||
return f"{self._inst.lower()}-{self.entity_description.key}-{slugify(str(self._data[self.entity_description.data_reference]).lower())}"
|
||||
else:
|
||||
return f"{self._inst.lower()}-{self.entity_description.key}"
|
||||
|
||||
@property
|
||||
def available(self) -> bool:
|
||||
"""Return if controller is available"""
|
||||
return self.coordinator.connected()
|
||||
|
||||
@property
|
||||
def device_info(self) -> DeviceInfo:
|
||||
"""Return a description for device registry."""
|
||||
dev_connection = DOMAIN
|
||||
dev_connection_value = self.entity_description.data_reference
|
||||
dev_group = self.entity_description.ha_group
|
||||
if self.entity_description.ha_group == "System":
|
||||
dev_group = self.coordinator.data["resource"]["board-name"]
|
||||
dev_connection_value = self.coordinator.data["routerboard"]["serial-number"]
|
||||
|
||||
if self.entity_description.ha_group.startswith("data__"):
|
||||
dev_group = self.entity_description.ha_group[6:]
|
||||
if dev_group in self._data:
|
||||
dev_group = self._data[dev_group]
|
||||
dev_connection_value = dev_group
|
||||
|
||||
if self.entity_description.ha_connection:
|
||||
dev_connection = self.entity_description.ha_connection
|
||||
|
||||
if self.entity_description.ha_connection_value:
|
||||
dev_connection_value = self.entity_description.ha_connection_value
|
||||
if dev_connection_value.startswith("data__"):
|
||||
dev_connection_value = dev_connection_value[6:]
|
||||
dev_connection_value = self._data[dev_connection_value]
|
||||
|
||||
info = DeviceInfo(
|
||||
connections={(dev_connection, f"{dev_connection_value}")},
|
||||
identifiers={(dev_connection, f"{dev_connection_value}")},
|
||||
default_name=f"{self._inst} {dev_group}",
|
||||
default_model=f"{self.coordinator.data['resource']['board-name']}",
|
||||
default_manufacturer=f"{self.coordinator.data['resource']['platform']}",
|
||||
sw_version=f"{self.coordinator.data['resource']['version']}",
|
||||
configuration_url=f"http://{self.coordinator.config_entry.data[CONF_HOST]}",
|
||||
via_device=(
|
||||
DOMAIN,
|
||||
f"{self.coordinator.data['routerboard']['serial-number']}",
|
||||
),
|
||||
)
|
||||
|
||||
if "mac-address" in self.entity_description.data_reference:
|
||||
dev_group = self._data[self.entity_description.data_name]
|
||||
dev_manufacturer = ""
|
||||
if dev_connection_value in self.coordinator.data["host"]:
|
||||
dev_group = self.coordinator.data["host"][dev_connection_value][
|
||||
"host-name"
|
||||
]
|
||||
dev_manufacturer = self.coordinator.data["host"][dev_connection_value][
|
||||
"manufacturer"
|
||||
]
|
||||
|
||||
info = DeviceInfo(
|
||||
connections={(dev_connection, f"{dev_connection_value}")},
|
||||
default_name=f"{dev_group}",
|
||||
default_manufacturer=f"{dev_manufacturer}",
|
||||
via_device=(
|
||||
DOMAIN,
|
||||
f"{self.coordinator.data['routerboard']['serial-number']}",
|
||||
),
|
||||
)
|
||||
|
||||
return info
|
||||
|
||||
@property
|
||||
def extra_state_attributes(self) -> Mapping[str, Any]:
|
||||
"""Return the state attributes."""
|
||||
attributes = super().extra_state_attributes
|
||||
for variable in self.entity_description.data_attributes_list:
|
||||
if variable in self._data:
|
||||
attributes[format_attribute(variable)] = self._data[variable]
|
||||
|
||||
return attributes
|
||||
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Run when entity about to be added to hass"""
|
||||
_LOGGER.debug("New entity %s (%s)", self._inst, self.unique_id)
|
||||
|
||||
async def async_will_remove_from_hass(self) -> None:
|
||||
"""Run when entity about to be removed from hass"""
|
||||
_LOGGER.debug("Removing entity %s (%s)", self._inst, self.unique_id)
|
||||
|
||||
async def start(self):
|
||||
"""Dummy run function"""
|
||||
raise NotImplementedError()
|
||||
|
||||
async def stop(self):
|
||||
"""Dummy stop function"""
|
||||
raise NotImplementedError()
|
||||
|
||||
async def restart(self):
|
||||
"""Dummy restart function"""
|
||||
raise NotImplementedError()
|
||||
|
||||
async def reload(self):
|
||||
"""Dummy reload function"""
|
||||
raise NotImplementedError()
|
||||
Loading…
Add table
Add a link
Reference in a new issue