Add Z-Stack 3.0.1 support to tools.nvram_read

Author: puddly

tests/test_tools_nvram.py

@@ -134,36 +134,45 @@ def close(self):
     return znp_server
 
 
-@pytest_mark_asyncio_timeout(seconds=5)
-async def test_nvram_read(openable_serial_znp_server, tmp_path):
-    def osal_nv_read(req):
-        nvid = NwkNvIds(req.Id).name
+def osal_nv_read(req):
+    nvid = NwkNvIds(req.Id).name
+
+    if nvid not in REAL_BACKUP["nwk"]:
+        return c.SYS.OSALNVRead.Rsp(Status=t.Status.INVALID_PARAMETER, Value=b"")
+
+    value = bytes.fromhex(REAL_BACKUP["nwk"][nvid])
+
+    return c.SYS.OSALNVRead.Rsp(Status=t.Status.SUCCESS, Value=value[req.Offset :])
+
+
+def nv_length(req):
+    nvid = OsalExNvIds(req.ItemId).name
 
-        if nvid not in REAL_BACKUP["nwk"]:
-            return c.SYS.OSALNVRead.Rsp(Status=t.Status.INVALID_PARAMETER, Value=b"")
+    if nvid not in REAL_BACKUP["osal"]:
+        return c.SYS.NVLength.Rsp(Length=0)
 
-        value = bytes.fromhex(REAL_BACKUP["nwk"][nvid])
+    value = bytes.fromhex(REAL_BACKUP["osal"][nvid])
 
-        return c.SYS.OSALNVRead.Rsp(Status=t.Status.SUCCESS, Value=value[req.Offset :])
+    return c.SYS.NVLength.Rsp(Length=len(value))
 
-    def nv_length(req):
-        nvid = OsalExNvIds(req.ItemId).name
 
-        if nvid not in REAL_BACKUP["osal"]:
-            return c.SYS.NVLength.Rsp(Length=0)
+def nv_read(req):
+    nvid = OsalExNvIds(req.ItemId).name
+    value = bytes.fromhex(REAL_BACKUP["osal"][nvid])
 
-        value = bytes.fromhex(REAL_BACKUP["osal"][nvid])
+    return c.SYS.NVRead.Rsp(
+        Status=t.Status.SUCCESS, Value=value[req.Offset :][: req.Length]
+    )
 
-        return c.SYS.NVLength.Rsp(Length=len(value))
 
-    def nv_read(req):
-        nvid = OsalExNvIds(req.ItemId).name
-        value = bytes.fromhex(REAL_BACKUP["osal"][nvid])
+def not_recognized(req):
+    return c.RPCError.CommandNotRecognized.Rsp(
+        ErrorCode=c.rpc_error.ErrorCode.InvalidCommandId, RequestHeader=req.header
+    )
 
-        return c.SYS.NVRead.Rsp(
-            Status=t.Status.SUCCESS, Value=value[req.Offset :][: req.Length]
-        )
 
+@pytest_mark_asyncio_timeout(seconds=5)
+async def test_nvram_read(openable_serial_znp_server, tmp_path):
     openable_serial_znp_server.reply_to(
         request=c.SYS.OSALNVRead.Req(partial=True), responses=[osal_nv_read],
     )
@@ -184,6 +193,34 @@ def nv_read(req):
     assert json.loads(backup_file.read_text()) == REAL_BACKUP
 
 
+@pytest_mark_asyncio_timeout(seconds=5)
+async def test_nvram_read_old_zstack(openable_serial_znp_server, tmp_path):
+    openable_serial_znp_server.reply_to(
+        request=c.SYS.OSALNVRead.Req(partial=True), responses=[osal_nv_read],
+    )
+
+    # SYS.NVLength doesn't exist
+    openable_serial_znp_server.reply_to(
+        request=c.SYS.NVLength.Req(partial=True), responses=[not_recognized],
+    )
+
+    # Nor does SYS.NVRead
+    openable_serial_znp_server.reply_to(
+        request=c.SYS.NVRead.Req(SysId=1, SubId=0, partial=True),
+        responses=[not_recognized],
+    )
+
+    backup_file = tmp_path / "backup.json"
+    await nvram_read([openable_serial_znp_server._port_path, "-o", str(backup_file)])
+
+    backup_without_osal = REAL_BACKUP.copy()
+    backup_without_osal["osal"] = {}
+
+    # The backup JSON written to disk should be an exact copy of our fake NVRAM,
+    # without the OSAL NVIDs
+    assert json.loads(backup_file.read_text()) == backup_without_osal
+
+
 @pytest_mark_asyncio_timeout(seconds=5)
 async def test_nvram_write(openable_serial_znp_server, tmp_path):
     simulated_nvram = {"osal": {}, "nwk": {}}

zigpy_znp/tools/nvram_read.py

@@ -10,11 +10,11 @@
 
 from zigpy_znp.api import ZNP
 from zigpy_znp.config import CONFIG_SCHEMA
-from zigpy_znp.exceptions import InvalidCommandResponse
+from zigpy_znp.exceptions import InvalidCommandResponse, CommandNotRecognized
 from zigpy_znp.types.nvids import NwkNvIds, OsalExNvIds
 
-coloredlogs.install(level=logging.DEBUG - 5)
-logging.getLogger("zigpy_znp").setLevel(logging.DEBUG - 5)
+coloredlogs.install(level=logging.DEBUG)
+logging.getLogger("zigpy_znp").setLevel(logging.DEBUG)
 
 LOGGER = logging.getLogger(__name__)
 
@@ -39,6 +39,14 @@ async def backup(radio_path):
             LOGGER.warning("Read failed for %s", nwk_nvid)
             continue
 
+    try:
+        # Old versions of Z-Stack do not have the OSAL NVIDs
+        await znp.request(
+            c.SYS.NVLength.Req(SysId=1, ItemId=OsalExNvIds.DEVICE_LIST, SubId=0)
+        )
+    except CommandNotRecognized:
+        return data
+
     for osal_nvid in OsalExNvIds:
         length_rsp = await znp.request(
             c.SYS.NVLength.Req(SysId=1, ItemId=osal_nvid, SubId=0)