meshcore-cli 1.1.36__tar.gz → 1.1.38__tar.gz

{meshcore_cli-1.1.36 → meshcore_cli-1.1.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meshcore-cli
-Version: 1.1.36
+Version: 1.1.38
 Summary: Command line interface to meshcore companion radios
 Project-URL: Homepage, https://github.com/fdlamotte/meshcore-cli
 Project-URL: Issues, https://github.com/fdlamotte/meshcore-cli/issues

{meshcore_cli-1.1.36 → meshcore_cli-1.1.38}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "meshcore-cli"
-version = "1.1.36"
+version = "1.1.38"
 authors = [
   { name="Florent de Lamotte", email="florent@frizoncorrea.fr" },
 ]

{meshcore_cli-1.1.36 → meshcore_cli-1.1.38}/src/meshcore_cli/meshcore_cli.py

@@ -23,7 +23,7 @@ from prompt_toolkit.shortcuts import radiolist_dialog
 from meshcore import MeshCore, EventType, logger
 
 # Version
-VERSION = "v1.1.36"
+VERSION = "v1.1.38"
 
 # default ble address is stored in a config file
 MCCLI_CONFIG_DIR = str(Path.home()) + "/.config/meshcore/"
@@ -69,7 +69,7 @@ def escape_ansi(line):
     ansi_escape = re.compile(r'(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]')
     return ansi_escape.sub('', line)
 
-def print_above(str):
+def print_one_line_above(str):
     """ prints a string above current line """
     width = os.get_terminal_size().columns
     stringlen = len(escape_ansi(str))-1
@@ -85,6 +85,11 @@ def print_above(str):
     print(str, end="")                          # Print output status msg
     print("\u001B[u", end="", flush=True)       # Jump back to saved cursor position
 
+def print_above(str):
+    lines = str.split('\n')
+    for l in lines:
+        print_one_line_above(l)
+
 async def process_event_message(mc, ev, json_output, end="\n", above=False):
     """ display incoming message """
     if ev is None :
@@ -350,6 +355,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
             "share_contact" : contact_list,
             "path": contact_list,
             "disc_path" : contact_list,
+            "trace" : None,
             "reset_path" : contact_list,
             "change_path" : contact_list,
             "change_flags" : contact_list,
@@ -439,6 +445,8 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
                 "upload_contact" : None,
                 "path": None,
                 "disc_path": None,
+                "trace": None,
+                "dtrace": None,
                 "reset_path" : None,
                 "change_path" : None,
                 "change_flags" : None,
@@ -804,6 +812,15 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                     await process_cmds(mc, ["cmd", contact["adv_name"], newline])
                 except IndexError:
                     print("Wrong number of parameters")
+
+            # trace called on a contact
+            elif contact["type"] > 0 and (
+                    line == "trace" or line == "tr") :
+                await print_trace_to(mc, contact)
+
+            elif contact["type"] > 0 and (
+                    line == "dtrace" or line == "dt") :
+                await print_disc_trace_to(mc, contact)
                 
             # same but for commands with a parameter
             elif contact["type"] > 0 and (line.startswith("cmd ") or\
@@ -1058,6 +1075,70 @@ async def get_channels (mc, anim=False) :
     print (" Done")
     return mc.channels
 
+async def print_trace_to (mc, contact):
+    path = contact["out_path"]
+    path_len = contact["out_path_len"]
+    trace = ""
+
+    if path_len == -1:
+        print ("No path to destination")
+        return
+
+    if contact["type"] == 2 or contact["type"] == 3:
+        # repeater or room, can trace to the contact itself
+        trace = contact["public_key"][0:2]
+
+    for i in range(0, path_len):
+        elem = path[2*(path_len-i-1):2*(path_len-i)]
+        trace = elem if trace=="" else f"{elem},{trace},{elem}"
+
+    await next_cmd(mc, ["trace", trace])
+
+async def discover_path(mc, contact):
+    await mc.ensure_contacts()
+    res = await mc.commands.send_path_discovery(contact)
+    if res.type == EventType.ERROR:
+        return None
+    else:
+        timeout = res.payload["suggested_timeout"]/600 if not "timeout" in contact or contact['timeout']==0 else contact["timeout"]
+        res = await mc.wait_for_event(EventType.PATH_RESPONSE, timeout=timeout)
+        if res is None:
+            return {"error": "timeout"}
+        else :
+            return res.payload
+
+async def print_disc_trace_to (mc, contact):
+    p = await discover_path(mc, contact)
+    if p is None:
+        print("Error discovering path")
+        return
+
+    if "error" in p:
+        print("Timeout discovering path")
+        return
+
+    inp = p["in_path"]
+    outp = p["out_path"]
+    inp_l = int(len(inp)/2)
+    outp_l = int(len(outp)/2)
+
+    trace = ""
+
+    for i in range(0, outp_l):
+        elem = outp[2*i:2*(i+1)]
+        trace = elem if trace == "" else f"{trace},{elem}"
+
+    if contact["type"] == 2 or contact["type"] == 3:
+        # repeater or room, can trace to the contact itself
+        elem = contact["public_key"][0:2]
+        trace = elem if trace == "" else f"{trace},{elem}"
+
+    for i in range(0, inp_l):
+        elem = inp[2*i:2*(i+1)]
+        trace = elem if trace == "" else f"{trace},{elem}"
+
+    await next_cmd(mc, ["trace", trace])
+
 async def next_cmd(mc, cmds, json_output=False):
     """ process next command """
     try :
@@ -1697,7 +1778,7 @@ async def next_cmd(mc, cmds, json_output=False):
                         print(res.payload)
                         print(json.dumps(res.payload, indent=4))
 
-            case "trace" :
+            case "trace" | "tr":
                 argnum = 1
                 res = await mc.commands.send_trace(path=cmds[1])
                 if res and res.type != EventType.ERROR:
@@ -1710,7 +1791,7 @@ async def next_cmd(mc, cmds, json_output=False):
                         if json_output:
                             print(json.dumps({"error" : "timeout waiting trace"}))
                         else :
-                            print("Timeout waiting trace")
+                            print(f"Timeout waiting trace for path {cmds[1]}")
                     elif ev.type == EventType.ERROR:
                         if json_output:
                             print(json.dumps(ev.payload))
@@ -1720,18 +1801,26 @@ async def next_cmd(mc, cmds, json_output=False):
                         if json_output:
                             print(json.dumps(ev.payload, indent=2))
                         else :
+                            classic = interactive_loop.classic or not process_event_message.color
                             print("]",end="")
                             for t in ev.payload["path"]:
-                                print("→",end="")
+                                if classic :
+                                    print("→",end="")
+                                else:
+                                    print(f" {ANSI_INVERT}", end="")
                                 snr = t['snr']
                                 if snr >= 10 :
-                                    print(ANSI_GREEN, end="")
+                                    print(ANSI_BGREEN, end="")
                                 elif snr <= 0:
-                                    print(ANSI_RED, end="")
+                                    print(ANSI_BRED, end="")
+                                else :
+                                    print(ANSI_BGRAY, end="")
                                 print(f"{snr:.2f}",end="")
-                                if snr >= 10 or snr <= 0:
-                                    print(ANSI_END, end="")
-                                print("→",end="")
+                                if classic :
+                                    print("→",end="")
+                                else :
+                                    print(f"{ANSI_NORMAL}🭬",end="")
+                                print(ANSI_END, end="")
                                 if "hash" in t:
                                     print(f"[{t['hash']}]",end="")
                                 else:
@@ -1834,26 +1923,19 @@ async def next_cmd(mc, cmds, json_output=False):
                 argnum = 1
                 await mc.ensure_contacts()
                 contact = mc.get_contact_by_name(cmds[1])
-                res = await mc.commands.send_path_discovery(contact)
-                logger.debug(res)
-                if res.type == EventType.ERROR:
+                res = await discover_path(mc, contact)
+                if res is None:
                     print(f"Error while discovering path")
                 else:
-                    timeout = res.payload["suggested_timeout"]/800 if not "timeout" in contact or contact['timeout']==0 else contact["timeout"]
-                    res = await mc.wait_for_event(EventType.PATH_RESPONSE, timeout=timeout)
-                    logger.debug(res)
-                    if res is None:
-                        if json_output :
-                            print(json.dumps({"error" : "Timeout discovering path"}))
-                        else:
-                            print("Timeout discovering path")
-                    else :
-                        if json_output :
-                            print(json.dumps(res.payload, indent=4))
+                    if json_output :
+                        print(json.dumps(res, indent=4))
+                    else:
+                        if "error" in res :
+                            print("Timeout while discovering path")
                         else:
-                            outp = res.payload['out_path']
+                            outp = res['out_path']
                             outp = outp if outp != "" else "direct"
-                            inp = res.payload['in_path']
+                            inp = res['in_path']
                             inp = inp if inp != "" else "direct"
                             print(f"Path for {contact['adv_name']}: out {outp}, in {inp}")
 
@@ -2048,12 +2130,16 @@ async def next_cmd(mc, cmds, json_output=False):
                     else:
                         print(f"Unknown contact {cmds[1]}")
                 else:
-                    res = await mc.commands.change_contact_path(contact, cmds[2])
-                    logger.debug(res)
-                    if res.type == EventType.ERROR:
-                        print(f"Error setting path: {res}")
-                    elif json_output :
-                        print(json.dumps(res.payload, indent=4))
+                    path = cmds[2].replace(",","") # we'll accept path with ,
+                    try:
+                        res = await mc.commands.change_contact_path(contact, path)
+                        logger.debug(res)
+                        if res.type == EventType.ERROR:
+                            print(f"Error setting path: {res}")
+                        elif json_output :
+                            print(json.dumps(res.payload, indent=4))
+                    except ValueError:
+                        print(f"Bad path format {cmds[2]}")
 
             case "change_flags" | "cf":
                 argnum = 2
@@ -2349,9 +2435,11 @@ async def process_script(mc, file, json_output=False):
         lines=f.readlines()
 
     for line in lines:
-        logger.debug(f"processing {line}")
-        cmds = shlex.split(line[:-1])
-        await process_cmds(mc, cmds, json_output)
+        line = line.strip()
+        if not (line == "" or line[0] == "#"):
+            logger.debug(f"processing {line}")
+            cmds = shlex.split(line)
+            await process_cmds(mc, cmds, json_output)
 
 def version():
     print (f"meshcore-cli: command line interface to MeshCore companion radios {VERSION}")
@@ -2399,6 +2487,7 @@ def command_help():
     import_contact <URI>   : import a contact from its URI          ic
     remove_contact <ct>    : removes a contact from this node
     path <ct>              : diplays path for a contact
+    disc_path <ct>         : discover new path and display          dp
     reset_path <ct>        : resets path to a contact to flood      rp
     change_path <ct> <pth> : change the path to a contact           cp
     change_flags <ct> <f>  : change contact flags (tel_l|tel_a|star)cf
@@ -2407,13 +2496,14 @@ def command_help():
     req_acl <ct>           : requests access control list for sensor
     pending_contacts       : show pending contacts
     add_pending <key>      : manually add pending contact from key
-    flush_pending          : flush pending contact clist
+    flush_pending          : flush pending contact list
   Repeaters
     login <name> <pwd>     : log into a node (rep) with given pwd   l
     logout <name>          : log out of a repeater
     cmd <name> <cmd>       : sends a command to a repeater (no ack) c  [
     wmt8                   : wait for a msg (reply) with a timeout     ]
-    req_status <name>      : requests status from a node            rs""")
+    req_status <name>      : requests status from a node            rs
+    trace <path>           : run a trace, path is comma separated""")
 
 def usage () :
     """ Prints some help """