meshcore-cli 1.2.5__tar.gz → 1.2.7__tar.gz

{meshcore_cli-1.2.5 → meshcore_cli-1.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meshcore-cli
-Version: 1.2.5
+Version: 1.2.7
 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
@@ -10,7 +10,7 @@ License-File: LICENSE
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
-Requires-Dist: meshcore>=2.1.19
+Requires-Dist: meshcore>=2.1.21
 Requires-Dist: prompt-toolkit>=3.0.50
 Requires-Dist: pycryptodome
 Requires-Dist: requests>=2.28.0

{meshcore_cli-1.2.5 → meshcore_cli-1.2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "meshcore-cli"
-version = "1.2.5"
+version = "1.2.7"
 authors = [
   { name="Florent de Lamotte", email="florent@frizoncorrea.fr" },
 ]
@@ -17,7 +17,7 @@ classifiers = [
 ]
 license = "MIT"
 license-files = ["LICEN[CS]E*"]
-dependencies = [ "meshcore >= 2.1.19", "prompt_toolkit >= 3.0.50", "requests >= 2.28.0", "pycryptodome" ]
+dependencies = [ "meshcore >= 2.1.21", "prompt_toolkit >= 3.0.50", "requests >= 2.28.0", "pycryptodome" ]
 
 [project.urls]
 Homepage = "https://github.com/fdlamotte/meshcore-cli"

{meshcore_cli-1.2.5 → meshcore_cli-1.2.7}/src/meshcore_cli/meshcore_cli.py

@@ -4,7 +4,7 @@
 """
 
 import asyncio
-import os, sys
+import os, sys, io
 import time, datetime
 import getopt, json, shlex, re
 import logging
@@ -33,7 +33,7 @@ import re
 from meshcore import MeshCore, EventType, logger
 
 # Version
-VERSION = "v1.2.5"
+VERSION = "v1.2.7"
 
 # default ble address is stored in a config file
 MCCLI_CONFIG_DIR = str(Path.home()) + "/.config/meshcore/"
@@ -208,15 +208,19 @@ async def handle_log_rx(event):
         return
 
     pkt = bytes().fromhex(event.payload["payload"])
+    pbuf = io.BytesIO(pkt)
+    header = pbuf.read(1)[0]
+
+    if header & ~1 == 0x14: # flood msg / channel
+        if handle_log_rx.channel_echoes:
+            if header & 1 == 0: # has transport code
+                pbuf.read(4)    # discard transport code
+            path_len = pbuf.read(1)[0]
+            path = pbuf.read(path_len).hex()
+            chan_hash = pbuf.read(1).hex()
+            cipher_mac = pbuf.read(2)
+            msg = pbuf.read() # until the end of buffer
 
-    if handle_log_rx.channel_echoes:
-        if pkt[0] == 0x15: 
-            chan_name = ""
-            path_len = pkt[1]
-            path = pkt[2:path_len+2].hex()
-            chan_hash = pkt[path_len+2:path_len+3].hex()
-            cipher_mac = pkt[path_len+3:path_len+5]
-            msg = pkt[path_len+5:]
             channel = None
             for c in await get_channels(mc):
                 if c["channel_hash"] == chan_hash : # validate against MAC
@@ -226,6 +230,8 @@ async def handle_log_rx(event):
                         channel = c
                         break
 
+            chan_name = ""
+
             if channel is None :
                 if handle_log_rx.echo_unk_chans:
                     chan_name = chan_hash
@@ -235,7 +241,7 @@ async def handle_log_rx(event):
                 aes_key = bytes.fromhex(channel["channel_secret"])
                 cipher = AES.new(aes_key, AES.MODE_ECB)
                 message = cipher.decrypt(msg)[5:].decode("utf-8").strip("\x00")
-            
+
             if chan_name != "" :
                 width = os.get_terminal_size().columns
                 cars = width - 13 - 2 * path_len - len(chan_name) - 1
@@ -245,7 +251,7 @@ async def handle_log_rx(event):
                     print_above(txt)
                 else:
                     print(txt)
-            
+
 handle_log_rx.json_log_rx = False
 handle_log_rx.channel_echoes = False
 handle_log_rx.mc = None
@@ -322,7 +328,7 @@ async def log_message(mc, msg):
     if msg["type"] == "PRIV" :
         ct = mc.get_contact_by_key_prefix(msg['pubkey_prefix'])
         if ct is None:
-            msg["name"] = data["pubkey_prefix"]
+            msg["name"] = msg["pubkey_prefix"]
         else:
             msg["name"] = ct["adv_name"]
     elif msg["type"] == "CHAN" :
@@ -366,7 +372,7 @@ async def subscribe_to_msgs(mc, json_output=False, above=False):
 class MyNestedCompleter(NestedCompleter):
     def get_completions( self, document, complete_event):
         txt = document.text_before_cursor.lstrip()
-        if not " " in txt: 
+        if not " " in txt:
             if txt != "" and txt[0] == "/" and txt.count("/") == 1:
                 opts = []
                 for k in self.options.keys():
@@ -445,6 +451,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
         "share_contact" : contact_list,
         "path": contact_list,
         "disc_path" : contact_list,
+        "node_discover": {"all":None, "sens":None, "rep":None, "comp":None, "room":None, "cli":None},
         "trace" : None,
         "reset_path" : contact_list,
         "change_path" : contact_list,
@@ -465,6 +472,9 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
         "set_channel": None,
         "get_channels": None,
         "remove_channel": None,
+        "apply_to": None,
+        "at": None,
+        "scope": None,
         "set" : {
             "name" : None,
             "pin" : None,
@@ -531,6 +541,8 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
 
     contact_completion_list = {
         "contact_info": None,
+        "contact_name": None,
+        "contact_lastmod": None,
         "export_contact" : None,
         "share_contact" : None,
         "upload_contact" : None,
@@ -569,6 +581,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
         "neighbors" : None,
         "req_acl":None,
         "setperm":contact_list,
+        "region" : {"get":None, "allowf": None, "denyf": None, "put": None, "remove": None, "save": None, "home": None},
         "gps" : {"on":None,"off":None,"sync":None,"setloc":None,
             "advert" : {"none": None, "share": None, "prefs": None},
         },
@@ -652,7 +665,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
     slash_root_completion_list = {}
     for k,v in root_completion_list.items():
         slash_root_completion_list["/"+k]=v
-    
+
     completion_list.update(slash_root_completion_list)
 
     slash_contacts_completion_list = {}
@@ -697,6 +710,14 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
     contact = to
     prev_contact = None
 
+    res = await mc.commands.set_flood_scope("0")
+    if res is None or res.type == EventType.ERROR: 
+        scope = None
+        prev_scope = None
+    else:
+        scope = "*"
+        prev_scope = "*"
+
     await get_contacts(mc, anim=True)
     await get_channels(mc, anim=True)
     await subscribe_to_msgs(mc, above=True)
@@ -748,6 +769,9 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
             if print_name or contact is None :
                 prompt = prompt + f"{ANSI_BGRAY}"
                 prompt = prompt + f"{mc.self_info['name']}"
+                if contact is None: # display scope
+                    if not scope is None:
+                        prompt = prompt + f"|{scope}"
                 if classic :
                     prompt = prompt + " > "
                 else :
@@ -775,6 +799,17 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                     prompt = prompt + f"{ANSI_NORMAL}🭨{ANSI_INVERT}"
 
                 prompt = prompt + f"{contact['adv_name']}"
+                if contact["type"] == 0 or contact["out_path_len"]==-1:
+                    if scope is None:
+                        prompt = prompt + f"|*"
+                    else:
+                        prompt = prompt + f"|{scope}"
+                else: # display path to dest or 0 if 0 hop
+                    if contact["out_path_len"] == 0:
+                        prompt = prompt + f"|0"
+                    else:
+                        prompt = prompt + "|" + contact["out_path"]
+
                 if classic :
                     prompt = prompt + f"{ANSI_NORMAL} > "
                 else:
@@ -802,6 +837,9 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
             if line == "" : # blank line
                 pass
 
+            elif line.startswith("?") :
+                get_help_for(line[1:], context="chat")
+
             # raw meshcli command as on command line
             elif line.startswith("$") :
                 try :
@@ -810,6 +848,12 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                 except ValueError:
                     logger.error("Error parsing line {line[1:]}")
 
+            elif line.startswith("/scope") :
+                if not scope is None:
+                    prev_scope = scope
+                    newscope = line.split(" ", 1)[1]
+                    scope = await set_scope(mc, newscope)
+
             elif line.startswith("/") :
                 path = line.split(" ", 1)[0]
                 if path.count("/") == 1:
@@ -905,6 +949,13 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                     if last_ack == False :
                         contact = ln
 
+            elif contact is None and\
+                    (line.startswith("apply_to ") or line.startswith("at ")):
+                try:
+                    await apply_command_to_contacts(mc, line.split(" ",2)[1], line.split(" ",2)[2])
+                except IndexError:
+                    logger.error(f"Error with apply_to command parameters")
+
             # commands are passed through if at root
             elif contact is None or line.startswith(".") :
                 try:
@@ -966,6 +1017,23 @@ async def process_contact_chat_line(mc, contact, line):
         await process_cmds(mc, args)
         return True
 
+    if line.startswith("contact_name") or line.startswith("cn"):
+        print(contact['adv_name'],end="")
+        if " " in line:
+            print(" ", end="", flush=True)
+            secline = line.split(" ", 1)[1]
+            await process_contact_chat_line(mc, contact, secline)
+        else:
+            print("")
+        return True
+
+    if line == "contact_lastmod":
+        timestamp = contact["lastmod"]
+        print(f"{contact['adv_name']} updated"
+              f" {datetime.datetime.fromtimestamp(timestamp).strftime('%Y-%m-%d at %H:%M:%S')}"
+              f" ({timestamp})")
+        return True
+
     # commands that take contact as second arg will be sent to recipient
     if line == "sc" or line == "share_contact" or\
             line == "ec" or line == "export_contact" or\
@@ -1053,7 +1121,7 @@ async def process_contact_chat_line(mc, contact, line):
         return True
 
     # same but for commands with a parameter
-    if line.startswith("cmd ") or\
+    if line.startswith("cmd ") or line.startswith("msg ") or\
             line.startswith("cp ") or line.startswith("change_path ") or\
             line.startswith("cf ") or line.startswith("change_flags ") or\
             line.startswith("req_binary ") or\
@@ -1085,7 +1153,7 @@ async def process_contact_chat_line(mc, contact, line):
 
         if password == "":
             try:
-                sess = PromptSession("Password: ", is_password=True)
+                sess = PromptSession(f"Password for {contact['adv_name']}: ", is_password=True)
                 password = await sess.prompt_async()
             except EOFError:
                 logger.info("Canceled")
@@ -1124,6 +1192,89 @@ async def process_contact_chat_line(mc, contact, line):
 
     return False
 
+async def apply_command_to_contacts(mc, contact_filter, line):
+    upd_before = None
+    upd_after = None
+    contact_type = None
+    min_hops = None
+    max_hops = None
+
+    await mc.ensure_contacts()
+
+    filters = contact_filter.split(",")
+    for f in filters:
+        if f == "all":
+            pass
+        elif f[0] == "u": #updated
+            val_str = f[2:]
+            t = time.time()
+            if val_str[-1] == "d": # value in days
+                t = t - float(val_str[0:-1]) * 86400
+            elif val_str[-1] == "h": # value in hours
+                t = t - float(val_str[0:-1]) * 3600
+            elif val_str[-1] == "m": # value in minutes
+                t = t - float(val_str[0:-1]) * 60
+            else:
+                t = int(val_str)
+            if f[1] == "<": #before
+                upd_before = t
+            elif f[1] == ">":
+                upd_after = t
+            else:
+                logger.error(f"Time filter can only be < or >")
+                return
+        elif f[0] == "t": # type
+            if f[1] == "=":
+                contact_type = int(f[2:])
+            else:
+                logger.error(f"Type can only be equals to a value")
+                return
+        elif f[0] == "d": # direct
+            min_hops=0
+        elif f[0] == "f": # flood
+            max_hops=-1
+        elif f[0] == "h": # hop number
+            if f[1] == ">":
+                min_hops = int(f[2:])+1
+            elif f[1] == "<":
+                max_hops = int(f[2:])-1
+            elif f[1] == "=":
+                min_hops = int(f[2:])
+                max_hops = int(f[2:])
+        else:
+            logger.error(f"Unknown filter {f}")
+            return
+
+    for c in dict(mc._contacts).items():
+        contact = c[1]
+        if (contact_type is None or contact["type"] == contact_type) and\
+                (upd_before is None or contact["lastmod"] < upd_before) and\
+                (upd_after is None or contact["lastmod"] > upd_after) and\
+                (min_hops is None or contact["out_path_len"] >= min_hops) and\
+                (max_hops is None or contact["out_path_len"] <= max_hops):
+            if await process_contact_chat_line(mc, contact, line):
+                pass
+
+            elif line == "remove_contact":
+                args = [line, contact['adv_name']]
+                await process_cmds(mc, args)
+
+            elif line.startswith("send") or line.startswith("\"") :
+                if line.startswith("send") :
+                    line = line[5:]
+                if line.startswith("\"") :
+                    line = line[1:]
+                await msg_ack(mc, contact, line)
+
+            elif contact["type"] == 2 or\
+                 contact["type"] == 3 or\
+                 contact["type"] == 4 : # repeater, room, sensor send cmd
+                await process_cmds(mc, ["cmd", contact["adv_name"], line])
+                # wait for a reply from cmd
+                await mc.wait_for_event(EventType.MESSAGES_WAITING, timeout=7)
+
+            else:
+                logger.error(f"Can't send {line} to {contact['adv_name']}")
 
 async def send_cmd (mc, contact, cmd) :
     res = await mc.commands.send_cmd(contact, cmd)
@@ -1187,6 +1338,14 @@ msg_ack.max_attempts=3
 msg_ack.flood_after=2
 msg_ack.max_flood_attempts=1
 
+async def set_scope (mc, scope) :
+    if scope == "None" or scope == "0" or scope == "clear" or scope == "":
+        scope = "*"
+    res = await mc.commands.set_flood_scope(scope)
+    if res is None or res.type == EventType.ERROR:
+        return None
+    return scope
+
 async def get_channel (mc, chan) :
     if not chan.isnumeric():
         return await get_channel_by_name(mc, chan)
@@ -1395,6 +1554,11 @@ async def next_cmd(mc, cmds, json_output=False):
     """ process next command """
     try :
         argnum = 0
+
+        if cmds[0].startswith("?") : # get some help
+            get_help_for(cmds[0][1:], context="line")
+            return cmds[argnum+1:]
+
         if cmds[0].startswith(".") : # override json_output
             json_output = True
             cmd = cmds[0][1:]
@@ -1485,6 +1649,10 @@ async def next_cmd(mc, cmds, json_output=False):
                 else:
                     print("Time set")
 
+            case "apply_to"|"at":
+                argnum = 2
+                await apply_command_to_contacts(mc, cmds[1], cmds[2])
+
             case "set":
                 argnum = 2
                 match cmds[1]:
@@ -1979,6 +2147,12 @@ async def next_cmd(mc, cmds, json_output=False):
                 if res is None:
                     print("Error setting channel")
 
+            case "scope":
+                argnum = 1
+                res = await set_scope(mc, cmds[1])
+                if res is None:
+                    print(f"Error while setting scope")
+
             case "remove_channel":
                 argnum = 1
                 res = await set_channel(mc, cmds[1], "", bytes.fromhex(16*"00"))
@@ -2045,7 +2219,7 @@ async def next_cmd(mc, cmds, json_output=False):
                 argnum = 2
                 dest = None
 
-                if len(cmds[1]) == 12: # possibly an hex prefix 
+                if len(cmds[1]) == 12: # possibly an hex prefix
                     try:
                         dest = bytes.fromhex(cmds[1])
                     except ValueError:
@@ -2243,6 +2417,52 @@ async def next_cmd(mc, cmds, json_output=False):
                             inp = inp if inp != "" else "direct"
                             print(f"Path for {contact['adv_name']}: out {outp}, in {inp}")
 
+            case "node_discover"|"nd" :
+                argnum = 1
+                try: # try to decode type as int
+                    types = int(cmds[1])
+                except ValueError:
+                    if "all" in cmds[1]:
+                        types = 0xFF
+                    else :
+                        types = 0
+                        if "rep" in cmds[1]:
+                            types = types | 4
+                        if "cli" in cmds[1] or "comp" in cmds[1]:
+                            types = types | 2
+                        if "room" in cmds[1]:
+                            types = types | 8
+                        if "sens" in cmds[1]:
+                            types = types | 16
+
+                res = await mc.commands.send_node_discover_req(types)
+                if res is None or res.type == EventType.ERROR:
+                    print("Error sending discover request")
+                else:
+                    exp_tag = res.payload["tag"].to_bytes(4, "little").hex()
+                    dn = []
+                    while True:
+                        r = await mc.wait_for_event(
+                            EventType.DISCOVER_RESPONSE,
+                            attribute_filters={"tag":exp_tag},
+                            timeout = 5
+                        )
+                        if r is None or r.type == EventType.ERROR:
+                            break
+                        else:
+                            dn.append(r.payload)
+
+                    if json_output:
+                        print(json.dumps(dn))
+                    else:
+                        await mc.ensure_contacts()
+                        print(f"Discovered {len(dn)} nodes:")
+                        for n in dn:
+                            name = mc.get_contact_by_key_prefix(n["pubkey"])['adv_name']
+                            if name is None:
+                                name = n["pubkey"][0:12]
+                            print(f" {name:12} type {n['node_type']} SNR: {n['SNR_in']:6,.2f}->{n['SNR']:6,.2f} RSSI: ->{n['RSSI']:4}")
+
             case "req_btelemetry"|"rbt" :
                 argnum = 1
                 await mc.ensure_contacts()
@@ -2718,7 +2938,7 @@ async def next_cmd(mc, cmds, json_output=False):
                 await mc.ensure_contacts()
                 contact = mc.get_contact_by_name(cmds[0])
                 if contact is None:
-                    logger.error(f"Unknown command : {cmd}. {cmds} not executed ...")
+                    logger.error(f"Unknown command : {cmd}, {cmds} not executed ...")
                     return None
 
                 await interactive_loop(mc, to=contact)
@@ -2762,7 +2982,8 @@ def version():
     print (f"meshcore-cli: command line interface to MeshCore companion radios {VERSION}")
 
 def command_help():
-    print("""  General commands
+    print("""    ?<cmd> may give you some more help about cmd
+  General commands
     chat                   : enter the chat (interactive) mode
     chat_to <ct>           : enter chat with contact                to
     script <filename>      : execute commands in filename
@@ -2773,6 +2994,7 @@ def command_help():
     reboot                 : reboots node
     sleep <secs>           : sleeps for a given amount of secs      s
     wait_key               : wait until user presses <Enter>        wk
+    apply_to <scope> <cmds>: sends cmds to contacts matching scope  at
   Messenging
     msg <name> <msg>       : send message to node by name           m  {
     wait_ack               : wait an ack                            wa }
@@ -2794,6 +3016,7 @@ def command_help():
     time <epoch>           : sets time to given epoch
     clock                  : get current time
     clock sync             : sync device clock                      st
+    node_discover <filter> : discovers nodes based on their type    nd
   Contacts
     contacts / list        : gets contact list                      lc
     reload_contacts        : force reloading all contacts           rc
@@ -2847,6 +3070,41 @@ def usage () :
  Available Commands and shorcuts (can be chained) :""")
     command_help()
 
+def get_help_for (cmdname, context="line") :
+    if cmdname == "apply_to" or cmdname == "at" :
+        print("""apply_to <scope> <cmd> : applies cmd to contacts matching scope
+    Scope acts like a filter with comma separated fields :
+     - u, matches modification time < or > than a timestamp
+            (can also be days hours or minutes ago if followed by d,h or m)
+     - t, matches the type (1: client, 2: repeater, 3: room, 4: sensor)
+     - h, matches number of hops
+     - d, direct, similar to h>-1
+     - f, flood, similar to h<0 or h=-1
+
+    Note: Some commands like contact_name (aka cn), reset_path (aka rp), forget_password (aka fp) can be chained.
+
+    Examples:
+        # removes all clients that have not been updated in last 2 days
+        at u<2d,t=1 remove_contact
+        # gives traces to repeaters that have been updated in the last 24h and are direct
+        at t=2,u>1d,d cn trace
+        # tries to do flood login to all repeaters
+        at t=2 rp login
+""")
+
+    if cmdname == "node_discover" or cmdname == "nd" :
+        print("""node_discover <filter> : discovers 0-hop nodes and displays signal info
+
+    filter can be "all" for all types or nodes or a comma separated list consisting of :
+     - cli or comp for companions
+     - rep for repeaters
+     - sens for sensors
+     - room for chat rooms
+""")
+
+    else:
+        print(f"Sorry, no help yet for {cmdname}")
+
 async def main(argv):
     """ Do the job """
     json_output = JSON