jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 13:17:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enable sensors based on wan scenario in Fritz!Tools (#66944)

Browse Source
This commit is contained in:
Michael 2022-02-21 18:03:38 +01:00 committed by GitHub
parent 7b334d1755
commit 660fb393f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
homeassistant/components/fritz/sensor.py
View File

@ -5,7 +5,7 @@ from collections.abc import Callable
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timedelta from datetime import datetime, timedelta
import logging import logging
from typing import Any, Literal from typing import Any
from fritzconnection.core.exceptions import FritzConnectionException from fritzconnection.core.exceptions import FritzConnectionException
from fritzconnection.lib.fritzstatus import FritzStatus from fritzconnection.lib.fritzstatus import FritzStatus
@ -134,6 +134,15 @@ def _retrieve_link_attenuation_received_state(
return status.attenuation[1] / 10 # type: ignore[no-any-return] return status.attenuation[1] / 10 # type: ignore[no-any-return]
@dataclass
class ConnectionInfo:
"""Fritz sensor connection information class."""
connection: str
mesh_role: MeshRoles
wan_enabled: bool
@dataclass @dataclass
class FritzRequireKeysMixin: class FritzRequireKeysMixin:
"""Fritz sensor data class.""" """Fritz sensor data class."""
@ -145,8 +154,7 @@ class FritzRequireKeysMixin:
class FritzSensorEntityDescription(SensorEntityDescription, FritzRequireKeysMixin): class FritzSensorEntityDescription(SensorEntityDescription, FritzRequireKeysMixin):
"""Describes Fritz sensor entity.""" """Describes Fritz sensor entity."""
connection_type: Literal["dsl"] | None = None is_suitable: Callable[[ConnectionInfo], bool] = lambda info: info.wan_enabled
exclude_mesh_role: MeshRoles = MeshRoles.SLAVE
SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = ( SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
@ -162,7 +170,7 @@ SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
device_class=SensorDeviceClass.TIMESTAMP, device_class=SensorDeviceClass.TIMESTAMP,
entity_category=EntityCategory.DIAGNOSTIC, entity_category=EntityCategory.DIAGNOSTIC,
value_fn=_retrieve_device_uptime_state, value_fn=_retrieve_device_uptime_state,
exclude_mesh_role=MeshRoles.NONE, is_suitable=lambda info: info.mesh_role != MeshRoles.NONE,
), ),
FritzSensorEntityDescription( FritzSensorEntityDescription(
key="connection_uptime", key="connection_uptime",
@ -225,7 +233,6 @@ SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
native_unit_of_measurement=DATA_RATE_KILOBITS_PER_SECOND, native_unit_of_measurement=DATA_RATE_KILOBITS_PER_SECOND,
icon="mdi:upload", icon="mdi:upload",
value_fn=_retrieve_link_kb_s_sent_state, value_fn=_retrieve_link_kb_s_sent_state,
connection_type=DSL_CONNECTION,
), ),
FritzSensorEntityDescription( FritzSensorEntityDescription(
key="link_kb_s_received", key="link_kb_s_received",
@ -233,7 +240,6 @@ SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
native_unit_of_measurement=DATA_RATE_KILOBITS_PER_SECOND, native_unit_of_measurement=DATA_RATE_KILOBITS_PER_SECOND,
icon="mdi:download", icon="mdi:download",
value_fn=_retrieve_link_kb_s_received_state, value_fn=_retrieve_link_kb_s_received_state,
connection_type=DSL_CONNECTION,
), ),
FritzSensorEntityDescription( FritzSensorEntityDescription(
key="link_noise_margin_sent", key="link_noise_margin_sent",
@ -241,7 +247,7 @@ SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS, native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
icon="mdi:upload", icon="mdi:upload",
value_fn=_retrieve_link_noise_margin_sent_state, value_fn=_retrieve_link_noise_margin_sent_state,
connection_type=DSL_CONNECTION, is_suitable=lambda info: info.wan_enabled and info.connection == DSL_CONNECTION,
), ),
FritzSensorEntityDescription( FritzSensorEntityDescription(
key="link_noise_margin_received", key="link_noise_margin_received",
@ -249,7 +255,7 @@ SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS, native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
icon="mdi:download", icon="mdi:download",
value_fn=_retrieve_link_noise_margin_received_state, value_fn=_retrieve_link_noise_margin_received_state,
connection_type=DSL_CONNECTION, is_suitable=lambda info: info.wan_enabled and info.connection == DSL_CONNECTION,
), ),
FritzSensorEntityDescription( FritzSensorEntityDescription(
key="link_attenuation_sent", key="link_attenuation_sent",
@ -257,7 +263,7 @@ SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS, native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
icon="mdi:upload", icon="mdi:upload",
value_fn=_retrieve_link_attenuation_sent_state, value_fn=_retrieve_link_attenuation_sent_state,
connection_type=DSL_CONNECTION, is_suitable=lambda info: info.wan_enabled and info.connection == DSL_CONNECTION,
), ),
FritzSensorEntityDescription( FritzSensorEntityDescription(
key="link_attenuation_received", key="link_attenuation_received",
@ -265,7 +271,7 @@ SENSOR_TYPES: tuple[FritzSensorEntityDescription, ...] = (
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS, native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
icon="mdi:download", icon="mdi:download",
value_fn=_retrieve_link_attenuation_received_state, value_fn=_retrieve_link_attenuation_received_state,
connection_type=DSL_CONNECTION, is_suitable=lambda info: info.wan_enabled and info.connection == DSL_CONNECTION,
), ),
) )
@ -278,19 +284,22 @@ async def async_setup_entry(
avm_wrapper: AvmWrapper = hass.data[DOMAIN][entry.entry_id] avm_wrapper: AvmWrapper = hass.data[DOMAIN][entry.entry_id]
link_properties = await avm_wrapper.async_get_wan_link_properties() link_properties = await avm_wrapper.async_get_wan_link_properties()
dsl: bool = link_properties.get("NewWANAccessType") == "DSL" connection_info = ConnectionInfo(
connection=link_properties.get("NewWANAccessType", "").lower(),
mesh_role=avm_wrapper.mesh_role,
wan_enabled=avm_wrapper.device_is_router,
)
_LOGGER.debug( _LOGGER.debug(
"WANAccessType of FritzBox %s is '%s'", "ConnectionInfo for FritzBox %s: %s",
avm_wrapper.host, avm_wrapper.host,
link_properties.get("NewWANAccessType"), connection_info,
) )
entities = [ entities = [
FritzBoxSensor(avm_wrapper, entry.title, description) FritzBoxSensor(avm_wrapper, entry.title, description)
for description in SENSOR_TYPES for description in SENSOR_TYPES
if (dsl or description.connection_type != DSL_CONNECTION) if description.is_suitable(connection_info)
and description.exclude_mesh_role != avm_wrapper.mesh_role
] ]
async_add_entities(entities, True) async_add_entities(entities, True)