Skip to content

Commit 87f0703

Browse files
TomeroeniTomeroeni
authored
Add support for port control in UniFi switch integration (home-assistant#150152)
1 parent a90ac61 commit 87f0703

File tree

3 files changed

+340
-1
lines changed

3 files changed

+340
-1
lines changed

‎homeassistant/components/unifi/switch.py‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@
2727
from aiounifi.interfaces.wlans import Wlans
2828
from aiounifi.models.api import ApiItem
2929
from aiounifi.models.client import Client, ClientBlockRequest
30-
from aiounifi.models.device import DeviceSetOutletRelayRequest
30+
from aiounifi.models.device import (
31+
DeviceSetOutletRelayRequest,
32+
DeviceSetPortEnabledRequest,
33+
)
3134
from aiounifi.models.dpi_restriction_app import DPIRestrictionAppEnableRequest
3235
from aiounifi.models.dpi_restriction_group import DPIRestrictionGroup
3336
from aiounifi.models.event import Event, EventKey
@@ -156,6 +159,14 @@ def async_outlet_switching_supported_fn(hub: UnifiHub, obj_id: str) -> bool:
156159
return outlet.has_relay or outlet.caps in (1, 3)
157160

158161

162+
@callback
163+
def async_port_control_supported_fn(hub: UnifiHub, obj_id: str) -> bool:
164+
"""Determine if a port supports switching."""
165+
port = hub.api.ports[obj_id]
166+
# Only allow switching for physical ports that exist
167+
return port.port_idx is not None
168+
169+
159170
async def async_outlet_control_fn(hub: UnifiHub, obj_id: str, target: bool) -> None:
160171
"""Control outlet relay."""
161172
mac, _, index = obj_id.partition("_")
@@ -174,6 +185,15 @@ async def async_poe_port_control_fn(hub: UnifiHub, obj_id: str, target: bool) ->
174185
hub.queue_poe_port_command(mac, int(index), state)
175186

176187

188+
async def async_port_control_fn(hub: UnifiHub, obj_id: str, target: bool) -> None:
189+
"""Control port enabled state."""
190+
mac, _, index = obj_id.partition("_")
191+
device = hub.api.devices[mac]
192+
await hub.api.request(
193+
DeviceSetPortEnabledRequest.create(device, int(index), target)
194+
)
195+
196+
177197
async def async_port_forward_control_fn(
178198
hub: UnifiHub, obj_id: str, target: bool
179199
) -> None:
@@ -338,6 +358,22 @@ class UnifiSwitchEntityDescription[HandlerT: APIHandler, ApiItemT: ApiItem](
338358
supported_fn=lambda hub, obj_id: bool(hub.api.ports[obj_id].port_poe),
339359
unique_id_fn=lambda hub, obj_id: f"poe-{obj_id}",
340360
),
361+
UnifiSwitchEntityDescription[Ports, Port](
362+
key="Port control",
363+
translation_key="port_control",
364+
device_class=SwitchDeviceClass.SWITCH,
365+
entity_category=EntityCategory.CONFIG,
366+
entity_registry_enabled_default=False,
367+
api_handler_fn=lambda api: api.ports,
368+
available_fn=async_device_available_fn,
369+
control_fn=async_port_control_fn,
370+
device_info_fn=async_device_device_info_fn,
371+
is_on_fn=lambda hub, port: bool(port.enabled),
372+
name_fn=lambda port: port.name,
373+
object_fn=lambda api, obj_id: api.ports[obj_id],
374+
supported_fn=async_port_control_supported_fn,
375+
unique_id_fn=lambda hub, obj_id: f"port-{obj_id}",
376+
),
341377
UnifiSwitchEntityDescription[Wlans, Wlan](
342378
key="WLAN control",
343379
translation_key="wlan_control",

‎tests/components/unifi/snapshots/test_switch.ambr‎

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,55 @@
194194
'state': 'on',
195195
})
196196
# ---
197+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_1-entry]
198+
EntityRegistryEntrySnapshot({
199+
'aliases': set({
200+
}),
201+
'area_id': None,
202+
'capabilities': None,
203+
'config_entry_id': <ANY>,
204+
'config_subentry_id': <ANY>,
205+
'device_class': None,
206+
'device_id': <ANY>,
207+
'disabled_by': None,
208+
'domain': 'switch',
209+
'entity_category': <EntityCategory.CONFIG: 'config'>,
210+
'entity_id': 'switch.mock_name_port_1',
211+
'has_entity_name': True,
212+
'hidden_by': None,
213+
'icon': None,
214+
'id': <ANY>,
215+
'labels': set({
216+
}),
217+
'name': None,
218+
'options': dict({
219+
}),
220+
'original_device_class': <SwitchDeviceClass.SWITCH: 'switch'>,
221+
'original_icon': None,
222+
'original_name': 'Port 1',
223+
'platform': 'unifi',
224+
'previous_unique_id': None,
225+
'suggested_object_id': None,
226+
'supported_features': 0,
227+
'translation_key': 'port_control',
228+
'unique_id': 'port-10:00:00:00:01:01_1',
229+
'unit_of_measurement': None,
230+
})
231+
# ---
232+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_1-state]
233+
StateSnapshot({
234+
'attributes': ReadOnlyDict({
235+
'device_class': 'switch',
236+
'friendly_name': 'mock-name Port 1',
237+
}),
238+
'context': <ANY>,
239+
'entity_id': 'switch.mock_name_port_1',
240+
'last_changed': <ANY>,
241+
'last_reported': <ANY>,
242+
'last_updated': <ANY>,
243+
'state': 'on',
244+
})
245+
# ---
197246
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_1_poe-entry]
198247
EntityRegistryEntrySnapshot({
199248
'aliases': set({
@@ -243,6 +292,55 @@
243292
'state': 'on',
244293
})
245294
# ---
295+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_2-entry]
296+
EntityRegistryEntrySnapshot({
297+
'aliases': set({
298+
}),
299+
'area_id': None,
300+
'capabilities': None,
301+
'config_entry_id': <ANY>,
302+
'config_subentry_id': <ANY>,
303+
'device_class': None,
304+
'device_id': <ANY>,
305+
'disabled_by': None,
306+
'domain': 'switch',
307+
'entity_category': <EntityCategory.CONFIG: 'config'>,
308+
'entity_id': 'switch.mock_name_port_2',
309+
'has_entity_name': True,
310+
'hidden_by': None,
311+
'icon': None,
312+
'id': <ANY>,
313+
'labels': set({
314+
}),
315+
'name': None,
316+
'options': dict({
317+
}),
318+
'original_device_class': <SwitchDeviceClass.SWITCH: 'switch'>,
319+
'original_icon': None,
320+
'original_name': 'Port 2',
321+
'platform': 'unifi',
322+
'previous_unique_id': None,
323+
'suggested_object_id': None,
324+
'supported_features': 0,
325+
'translation_key': 'port_control',
326+
'unique_id': 'port-10:00:00:00:01:01_2',
327+
'unit_of_measurement': None,
328+
})
329+
# ---
330+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_2-state]
331+
StateSnapshot({
332+
'attributes': ReadOnlyDict({
333+
'device_class': 'switch',
334+
'friendly_name': 'mock-name Port 2',
335+
}),
336+
'context': <ANY>,
337+
'entity_id': 'switch.mock_name_port_2',
338+
'last_changed': <ANY>,
339+
'last_reported': <ANY>,
340+
'last_updated': <ANY>,
341+
'state': 'on',
342+
})
343+
# ---
246344
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_2_poe-entry]
247345
EntityRegistryEntrySnapshot({
248346
'aliases': set({
@@ -292,6 +390,104 @@
292390
'state': 'on',
293391
})
294392
# ---
393+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_3-entry]
394+
EntityRegistryEntrySnapshot({
395+
'aliases': set({
396+
}),
397+
'area_id': None,
398+
'capabilities': None,
399+
'config_entry_id': <ANY>,
400+
'config_subentry_id': <ANY>,
401+
'device_class': None,
402+
'device_id': <ANY>,
403+
'disabled_by': None,
404+
'domain': 'switch',
405+
'entity_category': <EntityCategory.CONFIG: 'config'>,
406+
'entity_id': 'switch.mock_name_port_3',
407+
'has_entity_name': True,
408+
'hidden_by': None,
409+
'icon': None,
410+
'id': <ANY>,
411+
'labels': set({
412+
}),
413+
'name': None,
414+
'options': dict({
415+
}),
416+
'original_device_class': <SwitchDeviceClass.SWITCH: 'switch'>,
417+
'original_icon': None,
418+
'original_name': 'Port 3',
419+
'platform': 'unifi',
420+
'previous_unique_id': None,
421+
'suggested_object_id': None,
422+
'supported_features': 0,
423+
'translation_key': 'port_control',
424+
'unique_id': 'port-10:00:00:00:01:01_3',
425+
'unit_of_measurement': None,
426+
})
427+
# ---
428+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_3-state]
429+
StateSnapshot({
430+
'attributes': ReadOnlyDict({
431+
'device_class': 'switch',
432+
'friendly_name': 'mock-name Port 3',
433+
}),
434+
'context': <ANY>,
435+
'entity_id': 'switch.mock_name_port_3',
436+
'last_changed': <ANY>,
437+
'last_reported': <ANY>,
438+
'last_updated': <ANY>,
439+
'state': 'on',
440+
})
441+
# ---
442+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_4-entry]
443+
EntityRegistryEntrySnapshot({
444+
'aliases': set({
445+
}),
446+
'area_id': None,
447+
'capabilities': None,
448+
'config_entry_id': <ANY>,
449+
'config_subentry_id': <ANY>,
450+
'device_class': None,
451+
'device_id': <ANY>,
452+
'disabled_by': None,
453+
'domain': 'switch',
454+
'entity_category': <EntityCategory.CONFIG: 'config'>,
455+
'entity_id': 'switch.mock_name_port_4',
456+
'has_entity_name': True,
457+
'hidden_by': None,
458+
'icon': None,
459+
'id': <ANY>,
460+
'labels': set({
461+
}),
462+
'name': None,
463+
'options': dict({
464+
}),
465+
'original_device_class': <SwitchDeviceClass.SWITCH: 'switch'>,
466+
'original_icon': None,
467+
'original_name': 'Port 4',
468+
'platform': 'unifi',
469+
'previous_unique_id': None,
470+
'suggested_object_id': None,
471+
'supported_features': 0,
472+
'translation_key': 'port_control',
473+
'unique_id': 'port-10:00:00:00:01:01_4',
474+
'unit_of_measurement': None,
475+
})
476+
# ---
477+
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_4-state]
478+
StateSnapshot({
479+
'attributes': ReadOnlyDict({
480+
'device_class': 'switch',
481+
'friendly_name': 'mock-name Port 4',
482+
}),
483+
'context': <ANY>,
484+
'entity_id': 'switch.mock_name_port_4',
485+
'last_changed': <ANY>,
486+
'last_reported': <ANY>,
487+
'last_updated': <ANY>,
488+
'state': 'on',
489+
})
490+
# ---
295491
# name: test_entity_and_device_data[site_payload0-wlan_payload0-traffic_rule_payload0-port_forward_payload0-dpi_group_payload0-dpi_app_payload0-device_payload0-client_payload0-config_entry_options0][switch.mock_name_port_4_poe-entry]
296492
EntityRegistryEntrySnapshot({
297493
'aliases': set({

0 commit comments

Comments
 (0)