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

{meshcore_cli-1.3.11 → meshcore_cli-1.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meshcore-cli
-Version: 1.3.11
+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
@@ -21,6 +21,18 @@ Description-Content-Type: text/markdown
 
 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.11 → meshcore_cli-1.3.12}/README.md

@@ -2,6 +2,18 @@
 
 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.11 → 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.11 → meshcore_cli-1.3.12}/pyproject.toml

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

{meshcore_cli-1.3.11 → 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.11"
+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):
@@ -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 
@@ -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:
@@ -1538,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
 
@@ -1551,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
 
@@ -1564,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
 
@@ -1584,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
@@ -2500,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:
@@ -3494,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