meshcore-cli 1.3.8__tar.gz → 1.3.12__tar.gz

meshcore_cli-1.3.8/README.md → meshcore_cli-1.3.12/PKG-INFO

@@ -1,7 +1,38 @@
+Metadata-Version: 2.4
+Name: meshcore-cli
+Version: 1.3.12
+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
+Author-email: Florent de Lamotte <florent@frizoncorrea.fr>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: bleak<2.0,>=0.22
+Requires-Dist: meshcore>=2.2.3
+Requires-Dist: prompt-toolkit>=3.0.50
+Requires-Dist: pycryptodome
+Requires-Dist: requests>=2.28.0
+Description-Content-Type: text/markdown
+
 # meshcore-cli
 
 meshcore-cli : CLI interface to MeschCore companion app over BLE, TCP or Serial
 
+## About
+
+meshcore-cli is a tool that connects to your companion radio node (meshcore client) over BLE, TCP or Serial and lets you interact with it from a terminal using a command line interface.
+
+You can send commands as parameters to the meshcore-cli command (from your shell) either interactively or through a script.
+
+There is also an interactive mode (this is the default when no command is passed). In interactive mode you can enter a contact (another client a repeater, a sensor or a room) and interact with it. For clients, interaction consists in sending/receiving messages. For repeaters, rooms or sensors it will directly give you the remote cli (you can still send messages to rooms using double quote prefix or msg command).
+
+Note that meshcore-cli only interacts with companion radios (through BLE, Serial or TCP), you can't connect to a repeater using its serial interface.
+
+Also, most meshcore companions only have one interface compiled in at a time. So you can't connect via Serial to a node, which has been compiled as a BLE companion.
+
 ## Install
 
 Meshcore-cli depends on the [python meshcore](https://github.com/fdlamotte/meshcore_py) package. You can install both via `pip` or `pipx` using the command:

meshcore_cli-1.3.8/PKG-INFO → meshcore_cli-1.3.12/README.md

@@ -1,26 +1,19 @@
-Metadata-Version: 2.4
-Name: meshcore-cli
-Version: 1.3.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
-Author-email: Florent de Lamotte <florent@frizoncorrea.fr>
-License-Expression: MIT
-License-File: LICENSE
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
-Requires-Dist: bleak<2.0,>=0.22
-Requires-Dist: meshcore>=2.2.2
-Requires-Dist: prompt-toolkit>=3.0.50
-Requires-Dist: pycryptodome
-Requires-Dist: requests>=2.28.0
-Description-Content-Type: text/markdown
-
 # meshcore-cli
 
 meshcore-cli : CLI interface to MeschCore companion app over BLE, TCP or Serial
 
+## About
+
+meshcore-cli is a tool that connects to your companion radio node (meshcore client) over BLE, TCP or Serial and lets you interact with it from a terminal using a command line interface.
+
+You can send commands as parameters to the meshcore-cli command (from your shell) either interactively or through a script.
+
+There is also an interactive mode (this is the default when no command is passed). In interactive mode you can enter a contact (another client a repeater, a sensor or a room) and interact with it. For clients, interaction consists in sending/receiving messages. For repeaters, rooms or sensors it will directly give you the remote cli (you can still send messages to rooms using double quote prefix or msg command).
+
+Note that meshcore-cli only interacts with companion radios (through BLE, Serial or TCP), you can't connect to a repeater using its serial interface.
+
+Also, most meshcore companions only have one interface compiled in at a time. So you can't connect via Serial to a node, which has been compiled as a BLE companion.
+
 ## Install
 
 Meshcore-cli depends on the [python meshcore](https://github.com/fdlamotte/meshcore_py) package. You can install both via `pip` or `pipx` using the command:

{meshcore_cli-1.3.8 → meshcore_cli-1.3.12}/flake.nix

@@ -17,12 +17,12 @@
 
         meshcore = python3Packages.buildPythonPackage rec {
           pname = "meshcore";
-          version = "2.2.2";
+          version = "2.2.3";
           pyproject = true;
 
           src = python3Packages.fetchPypi {
             inherit pname version;
-            sha256 = "sha256-vn/vF4avMDwDLL0EMVrrMWkZrZ1GTiUxGyTBOtKvG1I=";
+            sha256 = "sha256-lmMflAlrNnfsc10J3CBxor9ftHK10bWyGTbjASJv82s=";
           };
 
           build-system = [ python3Packages.hatchling ];

{meshcore_cli-1.3.8 → meshcore_cli-1.3.12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "meshcore-cli"
-version = "1.3.8"
+version = "1.3.12"
 authors = [
   { name="Florent de Lamotte", email="florent@frizoncorrea.fr" },
 ]
@@ -17,7 +17,7 @@ classifiers = [
 ]
 license = "MIT"
 license-files = ["LICEN[CS]E*"]
-dependencies = [ "meshcore >= 2.2.2",
+dependencies = [ "meshcore >= 2.2.3",
 				 "bleak >= 0.22, <2.0", 
 				 "prompt_toolkit >= 3.0.50", 
 				 "requests >= 2.28.0", 

{meshcore_cli-1.3.8 → meshcore_cli-1.3.12}/src/meshcore_cli/meshcore_cli.py

@@ -32,7 +32,7 @@ import re
 from meshcore import MeshCore, EventType, logger
 
 # Version
-VERSION = "v1.3.8"
+VERSION = "v1.3.12"
 
 # default ble address is stored in a config file
 MCCLI_CONFIG_DIR = str(Path.home()) + "/.config/meshcore/"
@@ -72,6 +72,8 @@ ANSI_LIGHT_GREEN = "\033[0;92m"
 ANSI_LIGHT_YELLOW = "\033[0;93m"
 ANSI_LIGHT_GRAY="\033[0;38;5;247m"
 ANSI_BGRAY="\033[1;38;5;247m"
+ANSI_GRAY_BACK="\033[48;5;247m"
+ANSI_RESET_BACK="\033[49m"
 ANSI_ORANGE="\033[0;38;5;214m"
 ANSI_BORANGE="\033[1;38;5;214m"
 #ANSI_YELLOW="\033[0;38;5;226m"
@@ -82,8 +84,9 @@ ANSI_BYELLOW = "\033[1;33m"
 #Unicode chars
 # some possible symbols for prompts 🭬🬛🬗🭬🬛🬃🬗🭬🬛🬃🬗🬏🭀🭋🭨🮋
 ARROW_HEAD = ""
-SLASH_END = ""
-SLASH_START = ""
+SLASH_END = f"{ANSI_RESET_BACK}"
+#SLASH_START = ""
+SLASH_START = f"{ANSI_GRAY_BACK}"
 INVERT_SLASH = False
 
 def escape_ansi(line):
@@ -136,9 +139,9 @@ async def process_event_message(mc, ev, json_output, end="\n", above=False):
             ts = data["sender_timestamp"]
             if process_event_message.timestamp == "on":
                 if (abs(time.time()-ts) < 86400):
-                    fmt = "%H:%S"
+                    fmt = "%H:%M"
                 else:
-                    fmt = "%y-%m-%d %H:%S"
+                    fmt = "%y-%m-%d %H:%M"
             else:
                 fmt = process_event_message.timestamp
             path_str += f'{datetime.datetime.fromtimestamp(ts).strftime(fmt)},'
@@ -294,7 +297,7 @@ async def handle_log_rx(event):
                 chan_name = channel["channel_name"]
                 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")
+                message = cipher.decrypt(msg)[5:].decode("utf-8", "ignore").strip("\x00")
 
             if chan_name != "" :
                 width = os.get_terminal_size().columns
@@ -324,7 +327,7 @@ async def handle_log_rx(event):
             if flags & 0x40 > 0: #has feature2
                 adv_feat2 = pk_buf.read(2).hex()
             if flags & 0x80 > 0: #has name
-                adv_name = pk_buf.read().decode("utf-8").strip("\x00")
+                adv_name = pk_buf.read().decode("utf-8", "ignore").strip("\x00")
 
             if adv_name is None: 
                 # try to get the name from the contact 
@@ -334,14 +337,14 @@ async def handle_log_rx(event):
                 else:
                     adv_name = ct["adv_name"]
 
-            ts_string = ""
+            ts_str = ""
             if process_event_message.timestamp != "" and process_event_message.timestamp != "off":
                 ts = adv_timestamp
                 if process_event_message.timestamp == "on":
                     if (abs(time.time()-ts) < 86400):
-                        fmt = "%H:%S"
+                        fmt = "%H:%M"
                     else:
-                        fmt = "%y-%m-%d %H:%S"
+                        fmt = "%y-%m-%d %H:%M"
                 else:
                     fmt = process_event_message.timestamp
                 ts_str = f' at {datetime.datetime.fromtimestamp(ts).strftime(fmt)}'
@@ -443,10 +446,16 @@ async def log_message(mc, msg):
         ct = mc.get_contact_by_key_prefix(msg['pubkey_prefix'])
         if ct is None:
             msg["name"] = msg["pubkey_prefix"]
+            msg["sender"] = msg["pubkey_prefix"]
         else:
             msg["name"] = ct["adv_name"]
+            msg["sender"] = ct["adv_name"]
     elif msg["type"] == "CHAN" :
-        msg["name"] = f"channel {msg['channel_idx']}"
+        if hasattr(mc, 'channels') :
+            msg["sender"] = mc.channels[msg['channel_idx']]["channel_name"]
+        else:
+            msg["sender"] = f"channel {msg['channel_idx']}"
+        msg["name"] = msg["sender"]
     msg["timestamp"] = int(time.time())
 
     with open(log_message.file, "a") as logfile:
@@ -539,6 +548,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
 
     completion_list = {
         "to" : to_list,
+        "/to" : to_list,
         "public" : None,
         "chan" : None,
     }
@@ -599,6 +609,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
             "lat" : None,
             "lon" : None,
             "coords" : None,
+            "private_key": None,
             "print_snr" : {"on":None, "off": None},
             "print_timestamp" : {"on":None, "off": None, "%Y:%M":None},
             "json_msgs" : {"on":None, "off": None},
@@ -630,6 +641,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
             "coords":None,
             "lat":None,
             "lon":None,
+            "private_key":None,
             "print_snr":None,
             "print_timestamp":None,
             "json_msgs":None,
@@ -859,8 +871,6 @@ Some cmds have an help accessible with ?<cmd>. Do ?[Tab] to get a list.
 
     await subscribe_to_msgs(mc, above=True)
 
-    handle_new_contact.print_new_contacts = True
-
     try:
         if os.path.isdir(MCCLI_CONFIG_DIR) :
             our_history = FileHistory(MCCLI_HISTORY_FILE)
@@ -1000,6 +1010,9 @@ Some cmds have an help accessible with ?<cmd>. Do ?[Tab] to get a list.
                     except IndexError:
                         print(scope)
 
+            elif line == "quit" or line == "q" or line == "/quit" or line == "/q" :
+                break
+
             elif contact is None and (line.startswith("apply_to ") or line.startswith("at ")) or\
                  line.startswith("/apply_to ") or line.startswith("/at ") :
                 try:
@@ -1007,52 +1020,8 @@ Some cmds have an help accessible with ?<cmd>. Do ?[Tab] to get a list.
                 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(" ")
-                    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, 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 :
-                            try :
-                                await process_cmds(mc, shlex.split(line[1:]))
-                            except ValueError:
-                                logger.error(f"Error processing line{line[1:]}")
-                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")
-                    else:
-                        if not await process_contact_chat_line(mc, tct, cmdline):
-                            if cmdline != "":
-                                if tct["type"] == 1:
-                                    last_ack = await msg_ack(mc, tct, cmdline)
-                                else :
-                                    await process_cmds(mc, ["cmd", tct["adv_name"], cmdline])
-
-            elif line.startswith("to ") : # dest
-                dest = line[3:]
+            elif line.startswith("to ") or line.startswith("/to "): # dest
+                dest = line.split(" ", 1)[1]
                 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
@@ -1098,14 +1067,55 @@ Some cmds have an help accessible with ?<cmd>. Do ?[Tab] to get a list.
                     if not dest_scope is None:
                         scope = await set_scope(mc, dest_scope)
 
-            elif line == "to" :
+            elif line == "to" or line == "/to" :
                 if contact is None :
                     print(mc.self_info['name'])
                 else:
                     print(contact["adv_name"])
 
-            elif line == "quit" or line == "q" :
-                break
+            elif line.startswith("/") :
+                path = line.split(" ", 1)[0]
+                if path.count("/") == 1:
+                    args = line[1:].split(" ")
+                    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, 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 :
+                            try :
+                                await process_cmds(mc, shlex.split(line[1:]))
+                            except ValueError:
+                                logger.error(f"Error processing line{line[1:]}")
+                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")
+                    else:
+                        if not await process_contact_chat_line(mc, tct, cmdline):
+                            if cmdline != "":
+                                if tct["type"] == 1:
+                                    last_ack = await msg_ack(mc, tct, cmdline)
+                                else :
+                                    await process_cmds(mc, ["cmd", tct["adv_name"], cmdline])
 
             # commands that take one parameter (don't need quotes)
             elif line.startswith("public ") :
@@ -1537,10 +1547,11 @@ async def send_cmd (mc, contact, cmd) :
         if isinstance(contact, dict):
             sent = res.payload.copy()
             sent["type"] = "SENT_CMD"
-            sent["name"] = contact["adv_name"]
+            sent["recipient"] = contact["adv_name"]
             sent["text"] = cmd
             sent["txt_type"] = 1
-            sent["name"] = mc.self_info['name']
+            sent["sender"] = mc.self_info['name']
+            sent["name"] = sent["recipient"]
             await log_message(mc, sent)
     return res
 
@@ -1550,9 +1561,16 @@ async def send_chan_msg(mc, nb, msg):
         sent = res.payload.copy()
         sent["type"] = "SENT_CHAN"
         sent["channel_idx"] = nb
+        if hasattr(mc, "channels"):
+            chan_name = mc.channels[nb]["channel_name"]
+        else:
+            chan_name = f"channel {nb}"
+        sent["chan_name"] = chan_name
+        sent["recipient"] = chan_name
         sent["text"] = msg
         sent["txt_type"] = 0
-        sent["name"] = mc.self_info['name']
+        sent["sender"] = mc.self_info['name']
+        sent["name"] = chan_name
         await log_message(mc, sent)
     return res
 
@@ -1563,10 +1581,11 @@ async def send_msg (mc, contact, msg) :
         if isinstance(contact, dict):
             sent = res.payload.copy()
             sent["type"] = "SENT_MSG"
-            sent["name"] = contact["adv_name"]
+            sent["recipient"] = contact["adv_name"]
             sent["text"] = msg
             sent["txt_type"] = 0
-            sent["name"] = mc.self_info['name']
+            sent["sender"] = mc.self_info['name']
+            sent["name"] = sent["recipient"]
             await log_message(mc, sent)
     return res
 
@@ -1583,10 +1602,11 @@ async def msg_ack (mc, contact, msg) :
         if isinstance(contact, dict):
             sent = res.payload.copy()
             sent["type"] = "SENT_MSG"
-            sent["name"] = contact["adv_name"]
+            sent["recipient"] = contact["adv_name"]
             sent["text"] = msg
             sent["txt_type"] = 0
-            sent["name"] = mc.self_info['name']
+            sent["sender"] = mc.self_info['name']
+            sent["name"] = sent["recipient"]
             await log_message(mc, sent)
     return not res is None
 msg_ack.max_attempts=3
@@ -1604,8 +1624,11 @@ async def set_scope (mc, 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
+    if res is None :
+        return None
+
+    if res.type == EventType.ERROR:
+        if "error_code" in res.payload and res.payload["error_code"] == 1: #unsupported
             set_scope.has_scope = False
         return None
 
@@ -2073,6 +2096,16 @@ async def next_cmd(mc, cmds, json_output=False):
                             print(json.dumps(res.payload, indent=4))
                         else:
                             print("ok")
+                    case "private_key":
+                        params=bytes.fromhex(cmds[2])
+                        res = await mc.commands.import_private_key(params)
+                        logger.debug(res)
+                        if res.type == EventType.ERROR:
+                            print(f"Error: {res}")
+                        elif json_output :
+                            print(json.dumps(res.payload, indent=4))
+                        else:
+                            print("ok")
                     case "tuning":
                         params=cmds[2].commands.split(",")
                         res = await mc.commands.set_tuning(
@@ -2285,6 +2318,16 @@ async def next_cmd(mc, cmds, json_output=False):
                             print(json.dumps(res.payload, indent=4))
                         else:
                             print(f"Battery level : {res.payload['level']}")
+                    case "private_key":
+                        res = await mc.commands.export_private_key()
+                        logger.debug(res)
+                        if res.type == EventType.ERROR:
+                            print(f"Error exporting private key {res}")
+                        elif json_output :
+                            res.payload["private_key"] = res.payload["private_key"].hex()
+                            print(json.dumps(res.payload))
+                        else:
+                            print(f"Private key: {res.payload['private_key'].hex()}")
                     case "fstats" :
                         res = await mc.commands.get_bat()
                         logger.debug(res)
@@ -2476,7 +2519,9 @@ async def next_cmd(mc, cmds, json_output=False):
                 if cmds[1].isnumeric() :
                     nb = int(cmds[1])
                 else:
-                    nb = get_channel_by_name(mc, cmds[1])['channel_idx']
+                    chan = await get_channel_by_name(mc, cmds[1])
+                    print (chan)
+                    nb = chan['channel_idx']
                 res = await send_chan_msg(mc, nb, cmds[2])
                 logger.debug(res)
                 if res.type == EventType.ERROR:
@@ -3431,6 +3476,7 @@ def get_help_for (cmdname, context="line") :
     lon                : longitude
     radio              : radio parameters
     tx                 : tx power
+    private_key        : private key of the node
     print_snr          : snr display in messages
     print_adverts      : display adverts as they come
     print_new_contacts : display new pending contacts when available
@@ -3449,6 +3495,7 @@ def get_help_for (cmdname, context="line") :
     name <name>                 : node name
     lat <lat>                   : latitude
     lon <lon>                   : longitude
+    private_key                 : private key 
     coords <lat,lon>            : coordinates
     multi_ack <on/off>          : multi-acks feature
     telemetry_mode_base <mode>  : set basic telemetry mode all/selected/off
@@ -3468,7 +3515,7 @@ def get_help_for (cmdname, context="line") :
     json_log_rx <on/off>        : logs packets incoming to device as json
     channel_echoes <on/off>     : print repeats for channel data
     advert_echoes <on/off>      : print repeats for adverts
-    echo_unk_channels <on/off>  : also dump unk channels (encrypted)
+    echo_unk_chans <on/off>     : also dump unk channels (encrypted)
     color <on/off>              : color off should remove ANSI codes from output
   meshcore-cli behaviour:
     classic_prompt <on/off>     : activates less fancier prompt