starred/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2026-09-24 23:41:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add Elgato Wi-Fi signal sensors (#180758)

Browse Source
This commit is contained in:
Franck Nijhof
2026-08-30 12:26:19 +02:00
committed by GitHub
parent de2f8b61cb
commit ab69d806f2
5 changed files with 228 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
homeassistant/components/elgato/icons.json
+5
View File
@@ -13,6 +13,11 @@
"default": "mdi:power-settings"
}
},
"sensor": {
"wifi_signal_strength": {
"default": "mdi:wifi"
}
},
"switch": {
"bypass": {
"default": "mdi:battery-off-outline"
homeassistant/components/elgato/sensor.py
+21
View File
@@ -12,6 +12,7 @@ from homeassistant.components.sensor import (
)
from homeassistant.const import (
PERCENTAGE,
SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
EntityCategory,
UnitOfElectricCurrent,
UnitOfElectricPotential,
@@ -97,6 +98,26 @@ SENSORS = [
has_fn=lambda x: x.battery is not None,
value_fn=lambda x: x.battery.input_charge_voltage if x.battery else None,
),
ElgatoSensorEntityDescription(
key="wifi_signal_strength",
translation_key="wifi_signal_strength",
entity_category=EntityCategory.DIAGNOSTIC,
native_unit_of_measurement=PERCENTAGE,
state_class=SensorStateClass.MEASUREMENT,
has_fn=lambda x: x.info.wifi is not None,
value_fn=lambda x: x.info.wifi.signal_strength if x.info.wifi else None,
),
ElgatoSensorEntityDescription(
key="wifi_rssi",
translation_key="wifi_rssi",
entity_registry_enabled_default=False,
device_class=SensorDeviceClass.SIGNAL_STRENGTH,
entity_category=EntityCategory.DIAGNOSTIC,
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
state_class=SensorStateClass.MEASUREMENT,
has_fn=lambda x: x.info.wifi is not None,
value_fn=lambda x: x.info.wifi.rssi if x.info.wifi else None,
),
]
homeassistant/components/elgato/strings.json
+6
View File
@@ -65,6 +65,12 @@
},
"voltage": {
"name": "Battery voltage"
},
"wifi_rssi": {
"name": "Wi-Fi RSSI"
},
"wifi_signal_strength": {
"name": "Wi-Fi signal strength"
}
},
"switch": {
tests/components/elgato/snapshots/test_sensor.ambr
+177
View File
@@ -468,3 +468,180 @@
'via_device_id': None,
})
# ---
# name: test_sensors[sensor.frenck_wi_fi_rssi-key-light-mini]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.DEVICE_CLASS: 'device_class'>: 'signal_strength',
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'Frenck Wi-Fi RSSI',
<SensorEntityCapabilityAttribute.STATE_CLASS: 'state_class'>: <SensorStateClass.MEASUREMENT: 'measurement'>,
<EntityStateAttribute.UNIT_OF_MEASUREMENT: 'unit_of_measurement'>: 'dBm',
}),
'context': <ANY>,
'entity_id': 'sensor.frenck_wi_fi_rssi',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '-41',
})
# ---
# name: test_sensors[sensor.frenck_wi_fi_rssi-key-light-mini].1
EntityRegistryEntrySnapshot({
'aliases': list([
None,
]),
'area_id': None,
'capabilities': dict({
<SensorEntityCapabilityAttribute.STATE_CLASS: 'state_class'>: <SensorStateClass.MEASUREMENT: 'measurement'>,
}),
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.frenck_wi_fi_rssi',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Wi-Fi RSSI',
'options': dict({
}),
'original_device_class': <SensorDeviceClass.SIGNAL_STRENGTH: 'signal_strength'>,
'original_icon': None,
'original_name': 'Wi-Fi RSSI',
'platform': 'elgato',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'wifi_rssi',
'unique_id': 'GW24L1A02987_wifi_rssi',
'unit_of_measurement': 'dBm',
})
# ---
# name: test_sensors[sensor.frenck_wi_fi_rssi-key-light-mini].2
DeviceRegistryEntrySnapshot({
'area_id': None,
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'configuration_url': None,
'connections': set({
tuple(
'mac',
'aa:bb:cc:dd:ee:ff',
),
}),
'disabled_by': None,
'entry_type': None,
'hw_version': '202',
'id': <ANY>,
'identifiers': set({
tuple(
'elgato',
'GW24L1A02987',
),
}),
'labels': set({
}),
'manufacturer': 'Elgato',
'model': 'Elgato Key Light Mini',
'model_id': None,
'name': 'Frenck',
'name_by_user': None,
'serial_number': 'GW24L1A02987',
'sw_version': '1.0.4 (229)',
'via_device_id': None,
})
# ---
# name: test_sensors[sensor.frenck_wi_fi_signal_strength-key-light-mini]
StateSnapshot({
'attributes': ReadOnlyDict({
<EntityStateAttribute.FRIENDLY_NAME: 'friendly_name'>: 'Frenck Wi-Fi signal strength',
<SensorEntityCapabilityAttribute.STATE_CLASS: 'state_class'>: <SensorStateClass.MEASUREMENT: 'measurement'>,
<EntityStateAttribute.UNIT_OF_MEASUREMENT: 'unit_of_measurement'>: '%',
}),
'context': <ANY>,
'entity_id': 'sensor.frenck_wi_fi_signal_strength',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '100',
})
# ---
# name: test_sensors[sensor.frenck_wi_fi_signal_strength-key-light-mini].1
EntityRegistryEntrySnapshot({
'aliases': list([
None,
]),
'area_id': None,
'capabilities': dict({
<SensorEntityCapabilityAttribute.STATE_CLASS: 'state_class'>: <SensorStateClass.MEASUREMENT: 'measurement'>,
}),
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.frenck_wi_fi_signal_strength',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'object_id_base': 'Wi-Fi signal strength',
'options': dict({
}),
'original_device_class': None,
'original_icon': None,
'original_name': 'Wi-Fi signal strength',
'platform': 'elgato',
'previous_unique_id': None,
'suggested_object_id': None,
'supported_features': 0,
'translation_key': 'wifi_signal_strength',
'unique_id': 'GW24L1A02987_wifi_signal_strength',
'unit_of_measurement': '%',
})
# ---
# name: test_sensors[sensor.frenck_wi_fi_signal_strength-key-light-mini].2
DeviceRegistryEntrySnapshot({
'area_id': None,
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'configuration_url': None,
'connections': set({
tuple(
'mac',
'aa:bb:cc:dd:ee:ff',
),
}),
'disabled_by': None,
'entry_type': None,
'hw_version': '202',
'id': <ANY>,
'identifiers': set({
tuple(
'elgato',
'GW24L1A02987',
),
}),
'labels': set({
}),
'manufacturer': 'Elgato',
'model': 'Elgato Key Light Mini',
'model_id': None,
'name': 'Frenck',
'name_by_user': None,
'serial_number': 'GW24L1A02987',
'sw_version': '1.0.4 (229)',
'via_device_id': None,
})
# ---
tests/components/elgato/test_sensor.py
+19
View File
@@ -21,6 +21,8 @@ pytestmark = [
"sensor.frenck_charging_current",
"sensor.frenck_charging_power",
"sensor.frenck_charging_voltage",
"sensor.frenck_wi_fi_rssi",
"sensor.frenck_wi_fi_signal_strength",
],
)
async def test_sensors(
@@ -50,6 +52,7 @@ async def test_sensors(
"sensor.frenck_charging_current",
"sensor.frenck_charging_power",
"sensor.frenck_charging_voltage",
"sensor.frenck_wi_fi_rssi",
],
)
async def test_disabled_by_default_sensors(
@@ -61,3 +64,19 @@ async def test_disabled_by_default_sensors(
assert (entry := entity_registry.async_get(entity_id))
assert entry.disabled
assert entry.disabled_by is er.RegistryEntryDisabler.INTEGRATION
async def test_wifi_signal_strength_is_enabled(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
) -> None:
"""Test the signal strength percentage is on without asking for it.
A percentage is what someone can actually read, so it is the one that
shows up by default. The dBm behind it stays available but off.
"""
assert (state := hass.states.get("sensor.frenck_wi_fi_signal_strength"))
assert state.state == "100"
assert (entry := entity_registry.async_get("sensor.frenck_wi_fi_signal_strength"))
assert not entry.disabled