Name the Yellow-internal radio and multi-PAN addon as ZHA serial ports (#88208)
* Expose the Yellow-internal radio and multi-PAN addon as named serial ports * Remove the serial number if it isn't available * Use consistent names for the addon and Zigbee radio * Add `homeassistant_hardware` and `_yellow` as `after_dependencies` * Handle `hassio` not existing when listing serial ports * Add unit tests
This commit is contained in:
parent
f0b029c363
commit
9575cd9161
3 changed files with 94 additions and 4 deletions
|
@ -7,6 +7,7 @@ import json
|
|||
from typing import Any
|
||||
|
||||
import serial.tools.list_ports
|
||||
from serial.tools.list_ports_common import ListPortInfo
|
||||
import voluptuous as vol
|
||||
import zigpy.backups
|
||||
from zigpy.config import CONF_DEVICE, CONF_DEVICE_PATH
|
||||
|
@ -14,9 +15,13 @@ from zigpy.config import CONF_DEVICE, CONF_DEVICE_PATH
|
|||
from homeassistant import config_entries
|
||||
from homeassistant.components import onboarding, usb, zeroconf
|
||||
from homeassistant.components.file_upload import process_uploaded_file
|
||||
from homeassistant.components.hassio import AddonError, AddonState
|
||||
from homeassistant.components.homeassistant_hardware import silabs_multiprotocol_addon
|
||||
from homeassistant.components.homeassistant_yellow import hardware as yellow_hardware
|
||||
from homeassistant.const import CONF_NAME
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.data_entry_flow import FlowHandler, FlowResult
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.helpers.selector import FileSelector, FileSelectorConfig
|
||||
from homeassistant.util import dt
|
||||
|
||||
|
@ -72,6 +77,41 @@ def _format_backup_choice(
|
|||
return f"{dt.as_local(backup.backup_time).strftime('%c')} ({identifier})"
|
||||
|
||||
|
||||
async def list_serial_ports(hass: HomeAssistant) -> list[ListPortInfo]:
|
||||
"""List all serial ports, including the Yellow radio and the multi-PAN addon."""
|
||||
ports = await hass.async_add_executor_job(serial.tools.list_ports.comports)
|
||||
|
||||
# Add useful info to the Yellow's serial port selection screen
|
||||
try:
|
||||
yellow_hardware.async_info(hass)
|
||||
except HomeAssistantError:
|
||||
pass
|
||||
else:
|
||||
yellow_radio = next(p for p in ports if p.device == "/dev/ttyAMA1")
|
||||
yellow_radio.description = "Yellow Zigbee module"
|
||||
yellow_radio.manufacturer = "Nabu Casa"
|
||||
|
||||
# Present the multi-PAN addon as a setup option, if it's available
|
||||
addon_manager = silabs_multiprotocol_addon.get_addon_manager(hass)
|
||||
|
||||
try:
|
||||
addon_info = await addon_manager.async_get_addon_info()
|
||||
except (AddonError, KeyError):
|
||||
addon_info = None
|
||||
|
||||
if addon_info is not None and addon_info.state != AddonState.NOT_INSTALLED:
|
||||
addon_port = ListPortInfo(
|
||||
device=silabs_multiprotocol_addon.get_zigbee_socket(hass, addon_info),
|
||||
skip_link_detection=True,
|
||||
)
|
||||
|
||||
addon_port.description = "Multiprotocol add-on"
|
||||
addon_port.manufacturer = "Nabu Casa"
|
||||
ports.append(addon_port)
|
||||
|
||||
return ports
|
||||
|
||||
|
||||
class BaseZhaFlow(FlowHandler):
|
||||
"""Mixin for common ZHA flow steps and forms."""
|
||||
|
||||
|
@ -120,9 +160,9 @@ class BaseZhaFlow(FlowHandler):
|
|||
self, user_input: dict[str, Any] | None = None
|
||||
) -> FlowResult:
|
||||
"""Choose a serial port."""
|
||||
ports = await self.hass.async_add_executor_job(serial.tools.list_ports.comports)
|
||||
ports = await list_serial_ports(self.hass)
|
||||
list_of_ports = [
|
||||
f"{p}, s/n: {p.serial_number or 'n/a'}"
|
||||
f"{p}{', s/n: ' + p.serial_number if p.serial_number else ''}"
|
||||
+ (f" - {p.manufacturer}" if p.manufacturer else "")
|
||||
for p in ports
|
||||
]
|
||||
|
@ -146,7 +186,7 @@ class BaseZhaFlow(FlowHandler):
|
|||
return await self.async_step_manual_pick_radio_type()
|
||||
|
||||
self._title = (
|
||||
f"{port.description}, s/n: {port.serial_number or 'n/a'}"
|
||||
f"{port.description}{', s/n: ' + port.serial_number if port.serial_number else ''}"
|
||||
f" - {port.manufacturer}"
|
||||
if port.manufacturer
|
||||
else ""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue