meshcore-cli 1.2.6__tar.gz → 1.2.8__tar.gz

{meshcore_cli-1.2.6 → meshcore_cli-1.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meshcore-cli
-Version: 1.2.6
+Version: 1.2.8
 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.20
+Requires-Dist: meshcore>=2.1.22
 Requires-Dist: prompt-toolkit>=3.0.50
 Requires-Dist: pycryptodome
 Requires-Dist: requests>=2.28.0

{meshcore_cli-1.2.6 → meshcore_cli-1.2.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "meshcore-cli"
-version = "1.2.6"
+version = "1.2.8"
 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.20", "prompt_toolkit >= 3.0.50", "requests >= 2.28.0", "pycryptodome" ]
+dependencies = [ "meshcore >= 2.1.22", "prompt_toolkit >= 3.0.50", "requests >= 2.28.0", "pycryptodome" ]
 
 [project.urls]
 Homepage = "https://github.com/fdlamotte/meshcore-cli"

{meshcore_cli-1.2.6 → meshcore_cli-1.2.8}/src/meshcore_cli/meshcore_cli.py

@@ -33,7 +33,7 @@ import re
 from meshcore import MeshCore, EventType, logger
 
 # Version
-VERSION = "v1.2.6"
+VERSION = "v1.2.8"
 
 # default ble address is stored in a config file
 MCCLI_CONFIG_DIR = str(Path.home()) + "/.config/meshcore/"
@@ -451,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,
@@ -473,6 +474,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
         "remove_channel": None,
         "apply_to": None,
         "at": None,
+        "scope": None,
         "set" : {
             "name" : None,
             "pin" : None,
@@ -579,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},
         },
@@ -707,6 +710,8 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
     contact = to
     prev_contact = None
 
+    scope = await set_scope(mc, "*")
+
     await get_contacts(mc, anim=True)
     await get_channels(mc, anim=True)
     await subscribe_to_msgs(mc, above=True)
@@ -745,6 +750,9 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
 
         last_ack = True
         while True:
+            # reset scope (if changed)
+            scope = await set_scope(mc, scope)
+
             color = process_event_message.color
             classic = interactive_loop.classic or not color
             print_name = interactive_loop.print_name
@@ -758,6 +766,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 :
@@ -785,6 +796,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:
@@ -809,6 +831,8 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                                               completer=completer,
                                               key_bindings=bindings)
 
+            line = line.strip()
+
             if line == "" : # blank line
                 pass
 
@@ -823,18 +847,41 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                 except ValueError:
                     logger.error("Error parsing line {line[1:]}")
 
+            elif line.startswith("/scope") or\
+                    line.startswith("scope") and contact is None:
+                if not scope is None:
+                    prev_scope = scope
+                    try:
+                        newscope = line.split(" ", 1)[1]
+                        scope = await set_scope(mc, newscope)
+                    except IndexError:
+                        print(scope)
+
+            elif contact is None and (line.startswith("apply_to ") or line.startswith("at ")) or\
+                 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")
+
             elif line.startswith("/") :
                 path = line.split(" ", 1)[0]
                 if path.count("/") == 1:
                     args = line[1:].split(" ")
-                    tct = mc.get_contact_by_name(args[0])
+                    dest = args[0]
+                    dest_scope = None
+                    if "%" in dest :
+                        dest_scope = dest.split("%")[-1]
+                        dest = dest[:-len(dest_scope)-1]
+                        await set_scope (mc, dest_scope)
+                    tct = mc.get_contact_by_name(dest)
                     if len(args)>1 and not tct is None: # a contact, send a message
                         if tct["type"] == 1 or tct["type"] == 3: # client or room
                             last_ack = await msg_ack(mc, tct, line.split(" ", 1)[1])
                         else:
                             print("Can only send msg to chan, client or room")
                     else :
-                        ch = await get_channel_by_name(mc, args[0])
+                        ch = await get_channel_by_name(mc, dest)
                         if len(args)>1 and not ch is None: # a channel, send message
                             await send_chan_msg(mc, ch["channel_idx"], line.split(" ", 1)[1])
                         else :
@@ -845,6 +892,11 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                 else:
                     cmdline = line[1:].split("/",1)[1]
                     contact_name = path[1:].split("/",1)[0]
+                    dest_scope = None
+                    if "%" in contact_name:
+                        dest_scope = contact_name.split("%")[-1]
+                        contact_name = contact_name[:-len(dest_scope)-1]
+                        await set_scope (mc, dest_scope)
                     tct = mc.get_contact_by_name(contact_name)
                     if tct is None:
                         print(f"{contact_name} is not a contact")
@@ -860,6 +912,10 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                 dest = line[3:]
                 if dest.startswith("\"") or dest.startswith("\'") : # if name starts with a quote
                     dest = shlex.split(dest)[0] # use shlex.split to get contact name between quotes
+                dest_scope = None
+                if '%' in dest and scope!=None :
+                    dest_scope = dest.split("%")[-1]
+                    dest = dest[:-len(dest_scope)-1]
                 nc = mc.get_contact_by_name(dest)
                 if nc is None:
                     if dest == "public" :
@@ -873,6 +929,8 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                             nc["adv_name"] = mc.channels[dest]["channel_name"]
                     elif dest == ".." : # previous recipient
                         nc = prev_contact
+                        if dest_scope is None and not scope is None:
+                            dest_scope = prev_scope
                     elif dest == "~" or dest == "/" or dest == mc.self_info['name']:
                         nc = None
                     elif dest == "!" :
@@ -890,6 +948,12 @@ Line starting with \"$\" or \".\" will issue a meshcli command.
                     last_ack = True
                     prev_contact = contact
                     contact = nc
+                if dest_scope is None:
+                    dest_scope = scope
+                if not scope is None and dest_scope != scope:
+                    prev_scope = scope
+                    if not dest_scope is None:
+                        scope = await set_scope(mc, dest_scope)
 
             elif line == "to" :
                 if contact is None :
@@ -918,13 +982,6 @@ 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:
@@ -976,6 +1033,12 @@ async def process_contact_chat_line(mc, contact, line):
     if contact["type"] == 0:
         return False
 
+    # if one element in line (most cases) strip the scope and apply it
+    if not " " in line and "%" in line:
+        dest_scope = line.split("%")[-1]
+        line = line[:-len(dest_scope)-1]
+        await set_scope (mc, dest_scope)
+
     if line.startswith(":") : # : will send a command to current recipient
         args=["cmd", contact['adv_name'], line[1:]]
         await process_cmds(mc, args)
@@ -1090,15 +1153,21 @@ async def process_contact_chat_line(mc, contact, line):
         return True
 
     # same but for commands with a parameter
-    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\
-            line.startswith("login ") :
+    if " " in line:
         cmds = line.split(" ", 1)
-        args = [cmds[0], contact['adv_name'], cmds[1]]
-        await process_cmds(mc, args)
-        return True
+        if "%" in cmds[0]:
+            dest_scope = cmds[0].split("%")[-1]
+            cmds[0] = cmds[0][:-len(dest_scope)-1]
+            await set_scope(mc, dest_scope)
+
+        if cmds[0] == "cmd" or cmds[0] == "msg" or\
+                cmds[0] == "cp" or cmds[0] == "change_path" or\
+                cmds[0] == "cf" or cmds[0] == "change_flags" or\
+                cmds[0] == "req_binary" or\
+                cmds[0] == "login" :
+            args = [cmds[0], contact['adv_name'], cmds[1]]
+            await process_cmds(mc, args)
+            return True
 
     if line == "login": # use stored password or prompt for it
         password_file = ""
@@ -1287,7 +1356,7 @@ async def send_msg (mc, contact, msg) :
 
 async def msg_ack (mc, contact, msg) :
     timeout = 0 if not 'timeout' in contact else contact['timeout']
-    res = await mc.commands.send_msg_with_retry(contact, msg, 
+    res = await mc.commands.send_msg_with_retry(contact, msg,
                 max_attempts=msg_ack.max_attempts,
                 flood_after=msg_ack.flood_after,
                 max_flood_attempts=msg_ack.max_flood_attempts,
@@ -1307,6 +1376,28 @@ msg_ack.max_attempts=3
 msg_ack.flood_after=2
 msg_ack.max_flood_attempts=1
 
+async def set_scope (mc, scope) :
+    if not set_scope.has_scope:
+        return None
+
+    if scope == "None" or scope == "0" or scope == "clear" or scope == "":
+        scope = "*"
+
+    if set_scope.current_scope == scope:
+        return scope
+
+    res = await mc.commands.set_flood_scope(scope)
+    if res is None or res.type == EventType.ERROR:
+        if not res is None and res.payload["error_code"] == 1: #unsupported
+            set_scope.has_scope = False
+        return None
+
+    set_scope.current_scope = scope
+
+    return scope
+set_scope.has_scope = True
+set_scope.current_scope = None
+
 async def get_channel (mc, chan) :
     if not chan.isnumeric():
         return await get_channel_by_name(mc, chan)
@@ -2110,8 +2201,8 @@ async def next_cmd(mc, cmds, json_output=False):
 
             case "scope":
                 argnum = 1
-                res = await mc.commands.set_flood_scope(cmds[1])
-                if res is None or res.type == EventType.ERROR:
+                res = await set_scope(mc, cmds[1])
+                if res is None:
                     print(f"Error while setting scope")
 
             case "remove_channel":
@@ -2180,7 +2271,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:
@@ -2378,6 +2469,71 @@ 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
+                prefix_only = True
+
+                if len(cmds) == 1:
+                    argnum = 0
+                    types = 0xFF
+                else:
+                    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] or "rpt" 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
+
+                    if "full" in cmds[1]:
+                        prefix_only = False
+
+                res = await mc.commands.send_node_discover_req(types, prefix_only=prefix_only)
+                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 = f"{n['pubkey'][0:2]} {mc.get_contact_by_key_prefix(n['pubkey'])['adv_name']}"
+                            if name is None:
+                                name = n["pubkey"][0:16]
+                            type = f"t:{n['node_type']}"
+                            if n['node_type'] == 1:
+                                type = "CLI"
+                            elif n['node_type'] == 2:
+                                type = "REP"
+                            elif n['node_type'] == 3:
+                                type = "ROOM"
+                            elif n['node_type'] == 4:
+                                type = "SENS"
+
+                            print(f" {name:16} {type:>4} SNR: {n['SNR_in']:6,.2f}->{n['SNR']:6,.2f} RSSI: ->{n['RSSI']:4}")
+
             case "req_btelemetry"|"rbt" :
                 argnum = 1
                 await mc.ensure_contacts()
@@ -2931,6 +3087,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
@@ -3004,7 +3161,20 @@ def get_help_for (cmdname, context="line") :
         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
+
+    nd can be used with no filter parameter ... !!! BEWARE WITH CHAINING !!!
+""")
+
     else:
         print(f"Sorry, no help yet for {cmdname}")