From 587f7cd54ffdd4fda59a0fb885b902e8046c5b59 Mon Sep 17 00:00:00 2001 From: DamKas <48238600+DamKast@users.noreply.github.com> Date: Tue, 14 Nov 2023 17:01:53 +0100 Subject: [PATCH] update variable and class names --- zigpy_zboss/api.py | 22 ++++++++--------- zigpy_zboss/config.py | 4 +-- zigpy_zboss/exceptions.py | 6 ++--- zigpy_zboss/tools/README.md | 4 +-- zigpy_zboss/tools/factory_reset_ncp.py | 8 +++--- zigpy_zboss/tools/get_ncp_version.py | 8 +++--- zigpy_zboss/zigbee/application.py | 34 +++++++++++++------------- zigpy_zboss/zigbee/device.py | 8 +++--- 8 files changed, 47 insertions(+), 47 deletions(-) diff --git a/zigpy_zboss/api.py b/zigpy_zboss/api.py index 1eefdb8..791f7e6 100644 --- a/zigpy_zboss/api.py +++ b/zigpy_zboss/api.py @@ -1,4 +1,4 @@ -"""Module for nRF api interface.""" +"""Module for ZBOSS api interface.""" from __future__ import annotations import asyncio @@ -31,11 +31,11 @@ DEFAULT_TIMEOUT = 5 -class NRF: - """Class linking zigpy with the nRF SoC.""" +class ZBOSS: + """Class linking zigpy with ZBOSS running on nRF SoC.""" def __init__(self, config: conf.ConfigType): - """Initialize NRF class.""" + """Initialize ZBOSS class.""" self._uart = None self._app = None self._config = config @@ -54,7 +54,7 @@ def __init__(self, config: conf.ConfigType): self._ncp_debug = None def set_application(self, app): - """Set the application using the NRF class.""" + """Set the application using the ZBOSS class.""" assert self._app is None self._app = app @@ -63,8 +63,8 @@ def _port_path(self) -> str: return self._config[conf.CONF_DEVICE][conf.CONF_DEVICE_PATH] @property - def _nrf_config(self) -> conf.ConfigType: - return self._config[conf.CONF_NRF_CONFIG] + def _zboss_config(self) -> conf.ConfigType: + return self._config[conf.CONF_ZBOSS_CONFIG] async def connect(self) -> None: """Connect to serial device. @@ -98,7 +98,7 @@ def connection_lost(self, exc) -> None: """Port has been closed. Called by the UART object to indicate that the port was closed. - Propagates up to the `ControllerApplication` that owns this NRF + Propagates up to the `ControllerApplication` that owns this ZBOSS instance. """ LOGGER.debug("We were disconnected from %s: %s", self._port_path, exc) @@ -106,8 +106,8 @@ def connection_lost(self, exc) -> None: def close(self) -> None: """Clean up resources, namely the listener queues. - Calling this will reset NRF to the same internal state as a fresh NRF - instance. + Calling this will reset ZBOSS to the same internal state as a fresh + ZBOSS instance. """ self._app = None self.version = None @@ -253,7 +253,7 @@ def wait_for_response(self, response: t.CommandBase) -> asyncio.Future: def remove_listener(self, listener: BaseResponseListener) -> None: """ - Unbinds a listener from NRF. + Unbinds a listener from ZBOSS. Used by `wait_for_responses` to remove listeners for completed futures, regardless of their completion reason. diff --git a/zigpy_zboss/config.py b/zigpy_zboss/config.py index a3719a7..662a222 100644 --- a/zigpy_zboss/config.py +++ b/zigpy_zboss/config.py @@ -61,7 +61,7 @@ def validator(config): return validator -CONF_NRF_CONFIG = "nrf_config" +CONF_ZBOSS_CONFIG = "zboss_config" CONF_TX_POWER = "tx_power" CONF_LED_MODE = "led_mode" CONF_SKIP_BOOTLOADER = "skip_bootloader" @@ -74,7 +74,7 @@ def validator(config): CONFIG_SCHEMA = CONFIG_SCHEMA.extend( { vol.Required(CONF_DEVICE): SCHEMA_DEVICE, - vol.Optional(CONF_NRF_CONFIG, default={}): vol.Schema( + vol.Optional(CONF_ZBOSS_CONFIG, default={}): vol.Schema( vol.All( { vol.Optional(CONF_TX_POWER, default=None): vol.Any( diff --git a/zigpy_zboss/exceptions.py b/zigpy_zboss/exceptions.py index 6b18e28..a863e85 100644 --- a/zigpy_zboss/exceptions.py +++ b/zigpy_zboss/exceptions.py @@ -1,4 +1,4 @@ -"""Zigpy nrf exceptions.""" +"""Zigpy Zboss exceptions.""" class InvalidFrame(ValueError): @@ -17,5 +17,5 @@ class ModuleHardwareResetError(Exception): """Module hardware reset error.""" -class NrfResponseError(Exception): - """nRF response error.""" +class ZbossResponseError(Exception): + """ZBOSS response error.""" diff --git a/zigpy_zboss/tools/README.md b/zigpy_zboss/tools/README.md index bada657..569ad7a 100644 --- a/zigpy_zboss/tools/README.md +++ b/zigpy_zboss/tools/README.md @@ -1,8 +1,8 @@ # zigpy-zboss tools -- Factory reset the nRF NCP: +- Factory reset the zboss NCP: -`$ python -m zigpy_zboss.tools.factory_reset_ncp` +`$ python -m zigpy_zboss.tools.factory_reset_ncp ` - Get firmware, zigbee stack and protocol version: diff --git a/zigpy_zboss/tools/factory_reset_ncp.py b/zigpy_zboss/tools/factory_reset_ncp.py index ce60bd0..be98a2f 100644 --- a/zigpy_zboss/tools/factory_reset_ncp.py +++ b/zigpy_zboss/tools/factory_reset_ncp.py @@ -3,7 +3,7 @@ import serial import asyncio -from zigpy_zboss.api import NRF +from zigpy_zboss.api import ZBOSS from zigpy_zboss import types as t from zigpy_zboss.tools.config import get_config @@ -11,9 +11,9 @@ async def factory_reset_ncp(config): """Send factory reset command to NCP.""" - nrf = NRF(config) - await nrf.connect() - await nrf.reset(option=t.ResetOptions(2)) + zboss = ZBOSS(config) + await zboss.connect() + await zboss.reset(option=t.ResetOptions(2)) async def main(argv): diff --git a/zigpy_zboss/tools/get_ncp_version.py b/zigpy_zboss/tools/get_ncp_version.py index 7b9abbb..594890a 100644 --- a/zigpy_zboss/tools/get_ncp_version.py +++ b/zigpy_zboss/tools/get_ncp_version.py @@ -2,16 +2,16 @@ import serial import asyncio -from zigpy_zboss.api import NRF +from zigpy_zboss.api import ZBOSS from zigpy_zboss.tools.config import get_config async def get_ncp_version(config): """Get the NCP firmware version.""" - nrf = NRF(config) - await nrf.connect() - version = await nrf.version() + zboss = ZBOSS(config) + await zboss.connect() + version = await zboss.version() print("Current NCP versions: \n" f"FW: {version[0]}\n" f"Stack: {version[1]}\n" diff --git a/zigpy_zboss/zigbee/application.py b/zigpy_zboss/zigbee/application.py index 94c79e2..aaaa0bc 100644 --- a/zigpy_zboss/zigbee/application.py +++ b/zigpy_zboss/zigbee/application.py @@ -16,11 +16,11 @@ import zigpy_zboss.config as conf from typing import Any, Dict -from zigpy_zboss.api import NRF +from zigpy_zboss.api import ZBOSS from zigpy_zboss import commands as c from zigpy.exceptions import DeliveryError -from .device import NrfCoordinator, NrfDevice -from zigpy_zboss.exceptions import NrfResponseError +from .device import ZbossCoordinator, ZbossDevice +from zigpy_zboss.exceptions import ZbossResponseError from zigpy_zboss.config import CONFIG_SCHEMA, SCHEMA_DEVICE LOGGER = logging.getLogger(__name__) @@ -40,7 +40,7 @@ class ControllerApplication(zigpy.application.ControllerApplication): def __init__(self, config: Dict[str, Any]): """Initialize instance.""" super().__init__(config=zigpy.config.ZIGPY_SCHEMA(config)) - self._api: NRF | None = None + self._api: ZBOSS | None = None self._reset_task = None self.version = None @@ -49,10 +49,10 @@ async def connect(self): assert self._api is None is_responsive = await self.probe(self.config.get(conf.CONF_DEVICE, {})) if not is_responsive: - raise NrfResponseError - nrf = NRF(self.config) - await nrf.connect() - self._api = nrf + raise ZbossResponseError + zboss = ZBOSS(self.config) + await zboss.connect() + self._api = zboss self._api.set_application(self) self._bind_callbacks() @@ -76,7 +76,7 @@ async def start_network(self): await self.register_endpoints() - self.devices[self.state.node_info.ieee] = NrfCoordinator( + self.devices[self.state.node_info.ieee] = ZbossCoordinator( self, self.state.node_info.ieee, self.state.node_info.nwk ) @@ -466,9 +466,9 @@ def permit_with_key(self, node, code, time_s=60): raise NotImplementedError @property - def nrf_config(self) -> conf.ConfigType: - """Shortcut property to access the NRF radio config.""" - return self.config[conf.CONF_NRF_CONFIG] + def zboss_config(self) -> conf.ConfigType: + """Shortcut property to access the ZBOSS radio config.""" + return self.config[conf.CONF_ZBOSS_CONFIG] @classmethod async def probe( @@ -479,18 +479,18 @@ async def probe( """ config = cls.SCHEMA( {conf.CONF_DEVICE: cls.SCHEMA_DEVICE(device_config)}) - nrf = NRF(config) + zboss = ZBOSS(config) try: - await nrf.connect() + await zboss.connect() async with async_timeout.timeout(PROBE_TIMEOUT): - await nrf.request( + await zboss.request( c.NcpConfig.GetZigbeeRole.Req(TSN=1), timeout=1) except asyncio.TimeoutError: return False else: return device_config finally: - nrf.close() + zboss.close() # Overwrites zigpy because of custom ZDO layer required for ZBOSS. def add_device(self, ieee: t.EUI64, nwk: t.NWK): @@ -498,7 +498,7 @@ def add_device(self, ieee: t.EUI64, nwk: t.NWK): assert isinstance(ieee, t.EUI64) # TODO: Shut down existing device - dev = NrfDevice(self, ieee, nwk) + dev = ZbossDevice(self, ieee, nwk) self.devices[ieee] = dev return dev diff --git a/zigpy_zboss/zigbee/device.py b/zigpy_zboss/zigbee/device.py index 775872f..151044e 100644 --- a/zigpy_zboss/zigbee/device.py +++ b/zigpy_zboss/zigbee/device.py @@ -10,7 +10,7 @@ from zigpy.zdo import ZDO as ZigpyZDO -class NrfZDO(ZigpyZDO): +class ZbossZDO(ZigpyZDO): """The ZDO endpoint of a device.""" def handle_mgmt_permit_joining_req( @@ -225,18 +225,18 @@ async def Mgmt_NWK_Update_req(self, nwkUpdate): return (None, res.ScannedChannels, None, None, res.EnergyValues) -class NrfDevice(zigpy.device.Device): +class ZbossDevice(zigpy.device.Device): """Class representing an nRF device.""" def __init__(self, *args, **kwargs): """Initialize instance.""" super().__init__(*args, **kwargs) assert hasattr(self, "zdo") - self.zdo = NrfZDO(self) + self.zdo = ZbossZDO(self) self.endpoints[0] = self.zdo -class NrfCoordinator(NrfDevice): +class ZbossCoordinator(ZbossDevice): """Zigpy Device representing the controller.""" def __init__(self, *args, **kwargs):