mirror.MikroTik/tomaae.homeassistant-mikrotik_router
1
0
Fork 0
mirror of https://github.com/tomaae/homeassistant-mikrotik_router.git synced 2025-07-24 04:24:29 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

redo ppp and interface binary sensors

Browse source
This commit is contained in:
Tomaae 2022-02-04 22:46:18 +01:00
parent 167469b7d1
commit bd1cc7925c
3 changed files with 131 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

202
custom_components/mikrotik_router/binary_sensor.py
View file

@ -95,15 +95,6 @@ DEVICE_ATTRIBUTES_IFACE_SFP = [
"eeprom-checksum",
]
DEVICE_ATTRIBUTES_PPP_SECRET = [
"connected",
"service",
"profile",
"comment",
"caller-id",
"encoding",
]
# ---------------------------
# async_setup_entry
@ -137,44 +128,38 @@ def update_items(inst, config_entry, mikrotik_controller, async_add_entities, se
"""Update sensor state from the controller."""
new_sensors = []
# for sensor, sid_func in zip(
# # Sensor type name
# [
# "environment",
# ],
# # Entity function
# [
# MikrotikControllerSensor,
# ],
# ):
# if sensor.startswith("traffic_") and not config_entry.options.get(
# CONF_SENSOR_PORT_TRAFFIC, DEFAULT_SENSOR_PORT_TRAFFIC
# ):
# continue
#
# uid_sensor = SENSOR_TYPES[sensor]
# for uid in mikrotik_controller.data[SENSOR_TYPES[sensor].data_path]:
# uid_data = mikrotik_controller.data[SENSOR_TYPES[sensor].data_path]
# if (
# uid_sensor.data_path == "interface"
# and uid_data[uid]["type"] == "bridge"
# ):
# continue
#
# item_id = f"{inst}-{sensor}-{uid_data[uid][uid_sensor.data_reference]}"
# _LOGGER.debug("Updating binary sensor %s", item_id)
# if item_id in sensors:
# if sensors[item_id].enabled:
# sensors[item_id].async_schedule_update_ha_state()
# continue
#
# sensors[item_id] = sid_func(
# inst=inst,
# uid=uid,
# mikrotik_controller=mikrotik_controller,
# entity_description=uid_sensor,
# )
# new_sensors.append(sensors[item_id])
for sensor, sid_func in zip(
# Sensor type name
["ppp_tracker", "interface"],
# Entity function
[MikrotikControllerPPPSecretBinarySensor, MikrotikControllerPortBinarySensor],
):
if sensor == "interface" and not config_entry.options.get(
CONF_SENSOR_PORT_TRACKER, DEFAULT_SENSOR_PORT_TRACKER
):
continue
uid_sensor = SENSOR_TYPES[sensor]
for uid in mikrotik_controller.data[uid_sensor.data_path]:
uid_data = mikrotik_controller.data[uid_sensor.data_path]
if uid_sensor.data_path == "interface" and uid_data[uid]["type"] == "wlan":
continue
item_id = f"{inst}-{sensor}-{uid_data[uid][uid_sensor.data_reference]}"
_LOGGER.debug("Updating binary sensor %s", item_id)
if item_id in sensors:
if sensors[item_id].enabled:
sensors[item_id].async_schedule_update_ha_state()
continue
sensors[item_id] = sid_func(
inst=inst,
uid=uid,
mikrotik_controller=mikrotik_controller,
entity_description=uid_sensor,
config_entry=config_entry,
)
new_sensors.append(sensors[item_id])
for sensor in SENSOR_TYPES:
if sensor.startswith("system_"):
@ -191,6 +176,7 @@ def update_items(inst, config_entry, mikrotik_controller, async_add_entities, se
uid="",
mikrotik_controller=mikrotik_controller,
entity_description=uid_sensor,
config_entry=config_entry,
)
new_sensors.append(sensors[item_id])
@ -274,9 +260,11 @@ class MikrotikControllerBinarySensor(BinarySensorEntity):
uid: "",
mikrotik_controller,
entity_description: MikrotikBinarySensorEntityDescription,
config_entry,
):
"""Initialize."""
self.entity_description = entity_description
self._config_entry = config_entry
self._inst = inst
self._ctrl = mikrotik_controller
self._attr_extra_state_attributes = {ATTR_ATTRIBUTION: ATTRIBUTION}
@ -404,35 +392,18 @@ class MikrotikControllerBinarySensor(BinarySensorEntity):
class MikrotikControllerPPPSecretBinarySensor(MikrotikControllerBinarySensor):
"""Representation of a network device."""
def __init__(self, inst, uid, mikrotik_controller, config_entry, sid_data):
"""Initialize."""
super().__init__(mikrotik_controller, inst, uid)
self._sid_data = sid_data
self._data = mikrotik_controller.data[self._sid_data["sid"]][uid]
self._config_entry = config_entry
@property
def option_sensor_ppp(self) -> bool:
"""Config entry option."""
return self._config_entry.options.get(CONF_SENSOR_PPP, DEFAULT_SENSOR_PPP)
@property
def name(self) -> str:
"""Return the name."""
return f"{self._inst} PPP {self._data['name']}"
@property
def is_on(self) -> bool:
"""Return true if device is on."""
if not self.option_sensor_ppp:
return False
return self._data["connected"]
@property
def device_class(self) -> Optional[str]:
"""Return the device class."""
return BinarySensorDeviceClass.CONNECTIVITY
return self._data[self.entity_description.data_is_on]
@property
def available(self) -> bool:
@ -442,48 +413,6 @@ class MikrotikControllerPPPSecretBinarySensor(MikrotikControllerBinarySensor):
return self._ctrl.connected()
@property
def unique_id(self) -> str:
"""Return a unique id for this entity."""
return f"{self._inst.lower()}-{self._sid_data['sid']}_tracker-{self._data[self._sid_data['sid_ref']]}"
@property
def icon(self) -> str:
"""Return the icon."""
if self._data["connected"]:
return "mdi:account-network-outline"
else:
return "mdi:account-off-outline"
@property
def extra_state_attributes(self) -> Dict[str, Any]:
"""Return the state attributes."""
attributes = self._attrs
for variable in DEVICE_ATTRIBUTES_PPP_SECRET:
if variable in self._data:
attributes[format_attribute(variable)] = self._data[variable]
return attributes
@property
def device_info(self) -> Dict[str, Any]:
"""Return a description for device registry."""
info = {
"identifiers": {
(
DOMAIN,
"serial-number",
f"{self._ctrl.data['routerboard']['serial-number']}",
"switch",
"PPP",
)
},
"manufacturer": self._ctrl.data["resource"]["platform"],
"model": self._ctrl.data["resource"]["board-name"],
"name": f"{self._inst} PPP",
}
return info
# ---------------------------
# MikrotikControllerPortBinarySensor
@ -491,13 +420,6 @@ class MikrotikControllerPPPSecretBinarySensor(MikrotikControllerBinarySensor):
class MikrotikControllerPortBinarySensor(MikrotikControllerBinarySensor):
"""Representation of a network port."""
def __init__(self, inst, uid, mikrotik_controller, config_entry, sid_data):
"""Initialize."""
super().__init__(mikrotik_controller, inst, uid)
self._sid_data = sid_data
self._data = mikrotik_controller.data[self._sid_data["sid"]][uid]
self._config_entry = config_entry
@property
def option_sensor_port_tracker(self) -> bool:
"""Config entry option to not track ARP."""
@ -505,29 +427,6 @@ class MikrotikControllerPortBinarySensor(MikrotikControllerBinarySensor):
CONF_SENSOR_PORT_TRACKER, DEFAULT_SENSOR_PORT_TRACKER
)
@property
def name(self) -> str:
"""Return the name."""
return f"{self._inst} {self._data[self._sid_data['sid_name']]}"
@property
def unique_id(self) -> str:
"""Return a unique id for this entity."""
return (
f"{self._inst.lower()}-{self._sid_data['sid']}-"
f"{self._data['port-mac-address']}_{self._data['default-name']}"
)
@property
def is_on(self) -> bool:
"""Return true if device is on."""
return self._data["running"]
@property
def device_class(self) -> Optional[str]:
"""Return the device class."""
return BinarySensorDeviceClass.CONNECTIVITY
@property
def available(self) -> bool:
"""Return if controller is available."""
@ -539,10 +438,10 @@ class MikrotikControllerPortBinarySensor(MikrotikControllerBinarySensor):
@property
def icon(self) -> str:
"""Return the icon."""
if self._data["running"]:
icon = "mdi:lan-connect"
if self._data[self.entity_description.data_is_on]:
icon = self.entity_description.icon_enabled
else:
icon = "mdi:lan-pending"
icon = self.entity_description.icon_disabled
if not self._data["enabled"]:
icon = "mdi:lan-disconnect"
@ -550,9 +449,9 @@ class MikrotikControllerPortBinarySensor(MikrotikControllerBinarySensor):
return icon
@property
def extra_state_attributes(self) -> Dict[str, Any]:
def extra_state_attributes(self) -> Mapping[str, Any]:
"""Return the state attributes."""
attributes = self._attrs
attributes = super().extra_state_attributes
if self._data["type"] == "ether":
for variable in DEVICE_ATTRIBUTES_IFACE_ETHER:
@ -564,23 +463,4 @@ class MikrotikControllerPortBinarySensor(MikrotikControllerBinarySensor):
if variable in self._data:
attributes[format_attribute(variable)] = self._data[variable]
else:
for variable in self._sid_data["sid_attr"]:
if variable in self._data:
attributes[format_attribute(variable)] = self._data[variable]
return attributes
@property
def device_info(self) -> Dict[str, Any]:
"""Return a description for device registry."""
info = {
"connections": {
(CONNECTION_NETWORK_MAC, self._data[self._sid_data["sid_ref"]])
},
"manufacturer": self._ctrl.data["resource"]["platform"],
"model": self._ctrl.data["resource"]["board-name"],
"name": f"{self._inst} {self._data[self._sid_data['sid_name']]}",
}
return info

88
custom_components/mikrotik_router/binary_sensor_types.py
View file

@ -10,6 +10,62 @@ from homeassistant.components.binary_sensor import (
from .const import DOMAIN
DEVICE_ATTRIBUTES_PPP_SECRET = [
"connected",
"service",
"profile",
"comment",
"caller-id",
"encoding",
]
DEVICE_ATTRIBUTES_IFACE = [
"running",
"enabled",
"comment",
"client-ip-address",
"client-mac-address",
"port-mac-address",
"last-link-down-time",
"last-link-up-time",
"link-downs",
"actual-mtu",
"type",
"name",
]
DEVICE_ATTRIBUTES_IFACE_ETHER = [
"status",
"auto-negotiation",
"rate",
"full-duplex",
"default-name",
"poe-out",
]
DEVICE_ATTRIBUTES_IFACE_SFP = [
"status",
"auto-negotiation",
"advertising",
"link-partner-advertising",
"sfp-temperature",
"sfp-supply-voltage",
"sfp-module-present",
"sfp-tx-bias-current",
"sfp-tx-power",
"sfp-rx-power",
"sfp-rx-loss",
"sfp-tx-fault",
"sfp-type",
"sfp-connector-type",
"sfp-vendor-name",
"sfp-vendor-part-number",
"sfp-vendor-revision",
"sfp-vendor-serial",
"sfp-manufacturing-date",
"eeprom-checksum",
]
@dataclass
class MikrotikBinarySensorEntityDescription(BinarySensorEntityDescription):
@ -42,4 +98,36 @@ SENSOR_TYPES = {
data_uid="",
data_reference="",
),
"ppp_tracker": MikrotikBinarySensorEntityDescription(
key="ppp_tracker",
name="PPP",
icon_enabled="mdi:account-network-outline",
icon_disabled="mdi:account-off-outline",
device_class=BinarySensorDeviceClass.CONNECTIVITY,
ha_group="PPP",
ha_connection=DOMAIN,
ha_connection_value="PPP",
data_path="ppp_secret",
data_is_on="connected",
data_name="name",
data_uid="name",
data_reference="name",
data_attributes_list=DEVICE_ATTRIBUTES_PPP_SECRET,
),
"interface": MikrotikBinarySensorEntityDescription(
key="interface",
name="",
icon_enabled="mdi:lan-connect",
icon_disabled="mdi:lan-pending",
device_class=BinarySensorDeviceClass.CONNECTIVITY,
ha_group="data__default-name",
ha_connection=CONNECTION_NETWORK_MAC,
ha_connection_value="data__port-mac-address",
data_path="interface",
data_is_on="running",
data_name="name",
data_uid="default-name",
data_reference="default-name",
data_attributes_list=DEVICE_ATTRIBUTES_IFACE,
),
}

4
custom_components/mikrotik_router/sensor.py
View file

@ -89,8 +89,8 @@ def update_items(inst, config_entry, mikrotik_controller, async_add_entities, se
continue
uid_sensor = SENSOR_TYPES[sensor]
for uid in mikrotik_controller.data[SENSOR_TYPES[sensor].data_path]:
uid_data = mikrotik_controller.data[SENSOR_TYPES[sensor].data_path]
for uid in mikrotik_controller.data[uid_sensor.data_path]:
uid_data = mikrotik_controller.data[uid_sensor.data_path]
if (
uid_sensor.data_path == "interface"
and uid_data[uid]["type"] == "bridge"