Ruckus Unleashed Requested Changes (#41824)

This commit is contained in:
Gabe Cook authored and GitHub committed 2020-10-15 12:49:43 +02:00
1 parent a2574a4ed5
commit ffb4a9112b
12 files changed
+351 -79

No files matched your search

@@ -2,18 +2,30 @@
import asyncio
from pyruckus import Ruckus
import voluptuous as vol
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryNotReady
from homeassistant.helpers import device_registry
from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC
from .const import COORDINATOR, DOMAIN, PLATFORMS, UNDO_UPDATE_LISTENERS
from .const import (
API_AP,
API_DEVICE_NAME,
API_ID,
API_MAC,
API_MODEL,
API_SYSTEM_OVERVIEW,
API_VERSION,
COORDINATOR,
DOMAIN,
MANUFACTURER,
PLATFORMS,
UNDO_UPDATE_LISTENERS,
)
from .coordinator import RuckusUnleashedDataUpdateCoordinator
CONFIG_SCHEMA = vol.Schema({DOMAIN: vol.Schema({})}, extra=vol.ALLOW_EXTRA)
async def async_setup(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Set up the Ruckus Unleashed component."""
@@ -39,6 +51,21 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
if not coordinator.last_update_success:
raise ConfigEntryNotReady
system_info = await hass.async_add_executor_job(ruckus.system_info)
registry = await device_registry.async_get_registry(hass)
ap_info = await hass.async_add_executor_job(ruckus.ap_info)
for device in ap_info[API_AP][API_ID].values():
registry.async_get_or_create(
config_entry_id=entry.entry_id,
connections={(CONNECTION_NETWORK_MAC, device[API_MAC])},
identifiers={(CONNECTION_NETWORK_MAC, device[API_MAC])},
manufacturer=MANUFACTURER,
name=device[API_DEVICE_NAME],
model=device[API_MODEL],
sw_version=system_info[API_SYSTEM_OVERVIEW][API_VERSION],
)
hass.data[DOMAIN][entry.entry_id] = {
COORDINATOR: coordinator,
UNDO_UPDATE_LISTENERS: [],
@@ -1,4 +1,6 @@
"""Config flow for Ruckus Unleashed integration."""
import logging
from pyruckus import Ruckus
from pyruckus.exceptions import AuthenticationError
import voluptuous as vol
@@ -6,21 +8,25 @@ import voluptuous as vol
from homeassistant import config_entries, core, exceptions
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
from .const import _LOGGER, DOMAIN # pylint:disable=unused-import
from .const import ( # pylint:disable=unused-import
API_SERIAL,
API_SYSTEM_OVERVIEW,
DOMAIN,
)
_LOGGER = logging.getLogger(__package__)
DATA_SCHEMA = vol.Schema({"host": str, "username": str, "password": str})
async def validate_input(hass: core.HomeAssistant, data):
def validate_input(hass: core.HomeAssistant, data):
"""Validate the user input allows us to connect.
Data has the keys from DATA_SCHEMA with values provided by the user.
"""
try:
ruckus = await hass.async_add_executor_job(
Ruckus, data[CONF_HOST], data[CONF_USERNAME], data[CONF_PASSWORD]
)
ruckus = Ruckus(data[CONF_HOST], data[CONF_USERNAME], data[CONF_PASSWORD])
except AuthenticationError as error:
raise InvalidAuth from error
except ConnectionError as error:
@@ -28,7 +34,16 @@ async def validate_input(hass: core.HomeAssistant, data):
mesh_name = ruckus.mesh_name()
return {"title": mesh_name}
system_info = ruckus.system_info()
try:
host_serial = system_info[API_SYSTEM_OVERVIEW][API_SERIAL]
except KeyError as error:
raise CannotConnect from error
return {
"title": mesh_name,
"serial": host_serial,
}
class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
@@ -42,7 +57,9 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
errors = {}
if user_input is not None:
try:
info = await validate_input(self.hass, user_input)
info = await self.hass.async_add_executor_job(
validate_input, self.hass, user_input
)
except CannotConnect:
errors["base"] = "cannot_connect"
except InvalidAuth:
@@ -51,7 +68,7 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
_LOGGER.exception("Unexpected exception")
errors["base"] = "unknown"
else:
await self.async_set_unique_id(user_input[CONF_HOST])
await self.async_set_unique_id(info["serial"])
self._abort_if_unique_id_configured()
return self.async_create_entry(title=info["title"], data=user_input)
@@ -1,13 +1,23 @@
"""Constants for the Ruckus Unleashed integration."""
import logging
DOMAIN = "ruckus_unleashed"
PLATFORMS = ["device_tracker"]
SCAN_INTERVAL = 180
_LOGGER = logging.getLogger(__name__)
MANUFACTURER = "Ruckus"
COORDINATOR = "coordinator"
UNDO_UPDATE_LISTENERS = "undo_update_listeners"
CLIENTS = "clients"
API_CLIENTS = "clients"
API_NAME = "host_name"
API_MAC = "mac_address"
API_IP = "user_ip"
API_SYSTEM_OVERVIEW = "system_overview"
API_SERIAL = "serial_number"
API_DEVICE_NAME = "device_name"
API_MODEL = "model"
API_VERSION = "version"
API_AP = "ap"
API_ID = "id"
API_CURRENT_ACTIVE_CLIENTS = "current_active_clients"
API_ACCESS_POINT = "access_point"
@@ -1,5 +1,6 @@
"""Ruckus Unleashed DataUpdateCoordinator."""
from datetime import timedelta
import logging
from pyruckus import Ruckus
from pyruckus.exceptions import AuthenticationError
@@ -7,7 +8,15 @@ from pyruckus.exceptions import AuthenticationError
from homeassistant.core import HomeAssistant
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
from .const import _LOGGER, CLIENTS, DOMAIN, SCAN_INTERVAL
from .const import (
API_CLIENTS,
API_CURRENT_ACTIVE_CLIENTS,
API_MAC,
DOMAIN,
SCAN_INTERVAL,
)
_LOGGER = logging.getLogger(__package__)
class RuckusUnleashedDataUpdateCoordinator(DataUpdateCoordinator):
@@ -26,11 +35,16 @@ class RuckusUnleashedDataUpdateCoordinator(DataUpdateCoordinator):
update_interval=update_interval,
)
async def _fetch_clients(self) -> dict:
"""Fetch clients from the API and format them."""
clients = await self.hass.async_add_executor_job(
self.ruckus.current_active_clients
)
return {e[API_MAC]: e for e in clients[API_CURRENT_ACTIVE_CLIENTS][API_CLIENTS]}
async def _async_update_data(self) -> dict:
"""Fetch Ruckus Unleashed data."""
try:
return {
CLIENTS: await self.hass.async_add_executor_job(self.ruckus.clients)
}
return {API_CLIENTS: await self._fetch_clients()}
except (AuthenticationError, ConnectionError) as error:
raise UpdateFailed(error) from error
@@ -1,18 +1,24 @@
"""Support for Ruckus Unleashed devices."""
from homeassistant.components.device_tracker import (
ATTR_MAC,
ATTR_SOURCE_TYPE,
SOURCE_TYPE_ROUTER,
)
from typing import Optional
from homeassistant.components.device_tracker import SOURCE_TYPE_ROUTER
from homeassistant.components.device_tracker.config_entry import ScannerEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_NAME
from homeassistant.core import callback
from homeassistant.helpers import entity_registry
from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC
from homeassistant.helpers.typing import HomeAssistantType
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import CLIENTS, COORDINATOR, DOMAIN, UNDO_UPDATE_LISTENERS
from .const import (
API_ACCESS_POINT,
API_CLIENTS,
API_NAME,
COORDINATOR,
DOMAIN,
MANUFACTURER,
UNDO_UPDATE_LISTENERS,
)
async def async_setup_entry(
@@ -43,16 +49,16 @@ def add_new_entities(coordinator, async_add_entities, tracked):
"""Add new tracker entities from the router."""
new_tracked = []
for mac in coordinator.data[CLIENTS].keys():
for mac in coordinator.data[API_CLIENTS]:
if mac in tracked:
continue
device = coordinator.data[CLIENTS][mac]
new_tracked.append(RuckusUnleashedDevice(coordinator, mac, device[CONF_NAME]))
device = coordinator.data[API_CLIENTS][mac]
new_tracked.append(RuckusUnleashedDevice(coordinator, mac, device[API_NAME]))
tracked.add(mac)
if new_tracked:
async_add_entities(new_tracked, True)
async_add_entities(new_tracked)
@callback
@@ -62,7 +68,7 @@ def restore_entities(registry, coordinator, entry, async_add_entities, tracked):
for entity in registry.entities.values():
if entity.config_entry_id == entry.entry_id and entity.platform == DOMAIN:
if entity.unique_id not in coordinator.data[CLIENTS]:
if entity.unique_id not in coordinator.data[API_CLIENTS]:
missing.append(
RuckusUnleashedDevice(
coordinator, entity.unique_id, entity.original_name
@@ -71,7 +77,7 @@ def restore_entities(registry, coordinator, entry, async_add_entities, tracked):
tracked.add(entity.unique_id)
if missing:
async_add_entities(missing, True)
async_add_entities(missing)
class RuckusUnleashedDevice(CoordinatorEntity, ScannerEntity):
@@ -93,15 +99,15 @@ class RuckusUnleashedDevice(CoordinatorEntity, ScannerEntity):
"""Return the name."""
if self.is_connected:
return (
self.coordinator.data[CLIENTS][self._mac][CONF_NAME]
or f"Ruckus {self._mac}"
self.coordinator.data[API_CLIENTS][self._mac][API_NAME]
or f"{MANUFACTURER} {self._mac}"
)
return self._name
@property
def is_connected(self) -> bool:
"""Return true if the device is connected to the network."""
return self._mac in self.coordinator.data[CLIENTS]
return self._mac in self.coordinator.data[API_CLIENTS]
@property
def source_type(self) -> str:
@@ -109,9 +115,15 @@ class RuckusUnleashedDevice(CoordinatorEntity, ScannerEntity):
return SOURCE_TYPE_ROUTER
@property
def state_attributes(self) -> dict:
"""Return the state attributes."""
return {
ATTR_SOURCE_TYPE: self.source_type,
ATTR_MAC: self._mac,
}
def device_info(self) -> Optional[dict]:
"""Return the device information."""
if self.is_connected:
return {
"name": self.name,
"connections": {(CONNECTION_NETWORK_MAC, self._mac)},
"via_device": (
CONNECTION_NETWORK_MAC,
self.coordinator.data[API_CLIENTS][self._mac][API_ACCESS_POINT],
),
}
return None
@@ -4,13 +4,9 @@
"config_flow": true,
"documentation": "https://www.home-assistant.io/integrations/ruckus_unleashed",
"requirements": [
"pyruckus==0.7"
"pyruckus==0.12"
],
"ssdp": [],
"zeroconf": [],
"homekit": {},
"dependencies": [],
"codeowners": [
"@gabe565"
]
}
}