[otci] add support for IPv4, vendor commands, networkdiagnostics (openthread#11397)

With Thread 1.4 the cli application not can also (dns) resolve
IPv4 addresses. This commit adds the same support in otci

* dns_resolve4

Implements support for vendor operations in otci get/set

* vendor_name
* vendor_model
* vendor_sw_version

Implements network diagnostic commands

* get
* reset
* non_preferred_channels

Various other (small changes)"

* allow setting read timeout on serial connections
* allow replacing read routine filter
* expose latest thread versions in the public module api
* expand the definition of dns_get_config
* replaces mgmtget/mgmtset with the correct mgmtgetcommand and mgmtsetcommand
* replaces addressmode with the correct addrmode
* adds an `ignore_result` option to `execute_command`
* adds a missing `diag` command
* removes some unexisting getters

Author: Thomas

src/cli/README.md

@@ -1196,9 +1196,9 @@ CSL period is shown in microseconds.
 
 ```bash
 > csl
-Channel: 11
-Period: 160000us
-Timeout: 1000s
+channel: 11
+period: 160000us
+timeout: 1000s
 Done
 ```
 

src/cli/cli.cpp

@@ -7535,7 +7535,7 @@ template <> otError Interpreter::Process<Cmd("networkdiagnostic")>(Arg aArgs[])
      * @code
      * networkdiagnostic get ff02::1 0 1
      * DIAG_GET.rsp/ans: 00080e336e1c41494e1c01020c00
-     * Ext Address: '0e336e1c41494e1c'
+     * Ext Address: 0e336e1c41494e1c
      * Rloc16: 0x0c00
      * Done
      * DIAG_GET.rsp/ans: 00083efcdb7e3f9eb0f201021800

tools/otci/README.md

@@ -1,6 +1,6 @@
 # OpenThread Control Interface
 
-The OpenThread Control Interface (OTCI) is a library which provides uniform python interfaces to connect and control various kinds of devices running OpenThread.
+The OpenThread Control Interface (OTCI) is a library which provides uniform Python interfaces to connect and control various kinds of devices running OpenThread.
 
 ## Supported device types
 
@@ -22,7 +22,7 @@ node1 = otci.connect_otbr_ssh("192.168.1.101")
 # Connect to an OpenThread CLI device via Serial
 node2 = otci.connect_cli_serial("/dev/ttyACM0"))
 
-# Start node1 to become Leader
+# Start node1 and wait for it to become the Leader
 node1.dataset_init_buffer()
 node1.dataset_set_buffer(network_name='test', network_key='00112233445566778899aabbccddeeff', panid=0xface, channel=11)
 node1.dataset_commit_buffer('active')
@@ -32,7 +32,7 @@ node1.thread_start()
 node1.wait(5)
 assert node1.get_state() == "leader"
 
-# Start Commissioner on node1
+# Start the Commissioner role on node1
 node1.commissioner_start()
 node1.wait(3)
 
@@ -42,11 +42,11 @@ node1.commissioner_add_joiner("TEST123",eui64='*')
 node2.ifconfig_up()
 node2.set_router_selection_jitter(1)
 
-# Start Joiner on node2 to join the network
+# Start the Joiner role on node2 and wait for it to join the network
 node2.joiner_start("TEST123")
 node2.wait(10, expect_line="Join success")
 
-# Wait for node 2 to become Router
+# Wait for node 2 to become a Router
 node2.thread_start()
 node2.wait(5)
 assert node2.get_state() == "router"

tools/otci/otci/__init__.py

@@ -28,8 +28,9 @@
 #
 
 from . import errors
-from .constants import THREAD_VERSION_1_1, THREAD_VERSION_1_2
+from .constants import THREAD_VERSION_1_1, THREAD_VERSION_1_2, THREAD_VERSION_1_3, THREAD_VERSION_1_4
 from .command_handlers import OTCommandHandler
+from .connectors import OtCliHandler
 from .otci import OTCI
 from .otci import (
     connect_cli_sim,
@@ -56,6 +57,7 @@
 __all__ = [
     'OTCI',
     'OTCommandHandler',
+    'OTCliHandler',
     'errors',
     'Rloc16',
     'ChildId',

tools/otci/otci/command_handlers.py

@@ -84,26 +84,30 @@ def set_line_read_callback(self, callback: Optional[Callable[[str], Any]]):
     def shell(self, cmd: str, timeout: float) -> List[str]:
         raise NotImplementedError("shell command is not supported on %s" % self.__class__.__name__)
 
+    @classmethod
+    def set_filter(cls, filter: re.Pattern[str]):
+        return
+
 
 class OtCliCommandRunner(OTCommandHandler):
     __PATTERN_COMMAND_DONE_OR_ERROR = re.compile(
         r'(Done|Error|Error \d+:.*|.*: command not found)$')  # "Error" for spinel-cli.py
 
-    __PATTERN_LOG_LINE = re.compile(r'((\[(NONE|CRIT|WARN|NOTE|INFO|DEBG)\])'
+    __pattern_log_line = re.compile(r'((\[(NONE|CRIT|WARN|NOTE|INFO|DEBG)\])'
                                     r'|(-.*-+: )'  # e.g. -CLI-----:
                                     r'|(\[[DINWC\-]\] (?=[\w\-]{14}:)\w+-*:)'  # e.g. [I] Mac-----------:
                                     r')')
     """regex used to filter logs"""
 
-    assert __PATTERN_LOG_LINE.match('[I] ChannelMonitor: debug log')
-    assert __PATTERN_LOG_LINE.match('[I] Mac-----------: info log')
-    assert __PATTERN_LOG_LINE.match('[N] MeshForwarder-: note    log')
-    assert __PATTERN_LOG_LINE.match('[W] Notifier------: warn log')
-    assert __PATTERN_LOG_LINE.match('[C] Mle-----------: critical log')
-    assert __PATTERN_LOG_LINE.match('[-] Settings------: none log')
-    assert not __PATTERN_LOG_LINE.match('[-] Settings-----: none log')  # not enough `-` after module name
+    assert __pattern_log_line.match('[I] ChannelMonitor: debug log')
+    assert __pattern_log_line.match('[I] Mac-----------: info log')
+    assert __pattern_log_line.match('[N] MeshForwarder-: note    log')
+    assert __pattern_log_line.match('[W] Notifier------: warn log')
+    assert __pattern_log_line.match('[C] Mle-----------: critical log')
+    assert __pattern_log_line.match('[-] Settings------: none log')
+    assert not __pattern_log_line.match('[-] Settings-----: none log')  # not enough `-` after module name
 
-    __ASYNC_COMMANDS = {'scan', 'ping', 'discover'}
+    __ASYNC_COMMANDS = {'scan', 'ping', 'discover', 'networkdiagnostic get'}
 
     def __init__(self, otcli: OtCliHandler, is_spinel_cli: bool = False):
         self.__otcli: OtCliHandler = otcli
@@ -134,7 +138,8 @@ def execute_command(self, cmd: str, timeout: float = 10) -> List[str]:
 
         output = self.__expect_line(timeout,
                                     OtCliCommandRunner.__PATTERN_COMMAND_DONE_OR_ERROR,
-                                    asynchronous=cmd.split()[0] in OtCliCommandRunner.__ASYNC_COMMANDS)
+                                    asynchronous=any(cmd.startswith(x) for x in OtCliCommandRunner.__ASYNC_COMMANDS))
+
         return output
 
     def execute_platform_command(self, cmd: str, timeout: float = 10) -> List[str]:
@@ -162,6 +167,18 @@ def close(self):
     def set_line_read_callback(self, callback: Optional[Callable[[str], Any]]):
         self.__line_read_callback = callback
 
+    @classmethod
+    def set_filter(cls, filter: re.Pattern[str]):
+        """Set a different filter for the read routine that still matches the original filter"""
+        assert filter.match('[I] ChannelMonitor: debug log')
+        assert filter.match('[I] Mac-----------: info log')
+        assert filter.match('[N] MeshForwarder-: note    log')
+        assert filter.match('[W] Notifier------: warn log')
+        assert filter.match('[C] Mle-----------: critical log')
+        assert filter.match('[-] Settings------: none log')
+        assert not filter.match('[-] Settings-----: none log')  # not enough `-` after module name
+        cls.__pattern_log_line = filter
+
     #
     # Private methods
     #
@@ -216,6 +233,8 @@ def __otcli_read_routine(self):
             if line is None:
                 break
 
+            line = line.rstrip()
+
             if line.startswith('> '):
                 line = line[2:]
 
@@ -224,8 +243,9 @@ def __otcli_read_routine(self):
 
             logging.debug('%s: %s', self.__otcli, line)
 
-            if not OtCliCommandRunner.__PATTERN_LOG_LINE.match(line):
-                logging.info('%s: %s', self.__otcli, line)
+            if not OtCliCommandRunner.__pattern_log_line.match(line):
+                if line:
+                    logging.info('%s: %s', self.__otcli, line)
                 self.__pending_lines.put(line)
 
 

tools/otci/otci/connectors.py

@@ -138,12 +138,12 @@ def __init__(self, executable: str, nodeid: int, simulator: Optional[Simulator])
 class OtCliSerial(OtCliHandler):
     """Connector for OT CLI SOC devices via Serial."""
 
-    def __init__(self, dev: str, baudrate: int):
+    def __init__(self, dev: str, baudrate: int, timeout: float = 0.1):
         self.__dev = dev
         self.__baudrate = baudrate
 
         import serial
-        self.__serial = serial.Serial(self.__dev, self.__baudrate, timeout=0.1, exclusive=True)
+        self.__serial = serial.Serial(self.__dev, self.__baudrate, timeout=timeout, exclusive=True)
         self.writeline('\r\n')
         self.__linebuffer = b''