meshcore-cli 1.3.7__py3-none-any.whl → 1.3.8__py3-none-any.whl

meshcore_cli/meshcore_cli.py

@@ -32,7 +32,7 @@ import re
 from meshcore import MeshCore, EventType, logger
 
 # Version
-VERSION = "v1.3.7"
+VERSION = "v1.3.8"
 
 # default ble address is stored in a config file
 MCCLI_CONFIG_DIR = str(Path.home()) + "/.config/meshcore/"
@@ -130,10 +130,23 @@ async def process_event_message(mc, ev, json_output, end="\n", above=False):
         await mc.ensure_contacts()
         data = ev.payload
 
+        path_str = ""
+
+        if process_event_message.timestamp != "" and process_event_message.timestamp != "off":
+            ts = data["sender_timestamp"]
+            if process_event_message.timestamp == "on":
+                if (abs(time.time()-ts) < 86400):
+                    fmt = "%H:%S"
+                else:
+                    fmt = "%y-%m-%d %H:%S"
+            else:
+                fmt = process_event_message.timestamp
+            path_str += f'{datetime.datetime.fromtimestamp(ts).strftime(fmt)},'
+
         if data['path_len'] == 255 :
-            path_str = "D"
+            path_str += "D"
         else :
-            path_str = f"{data['path_len']}"
+            path_str += f"{data['path_len']}"
         if "SNR" in data and process_event_message.print_snr:
             path_str = path_str + f",{data['SNR']}dB"
 
@@ -206,6 +219,7 @@ async def process_event_message(mc, ev, json_output, end="\n", above=False):
 process_event_message.print_snr=False
 process_event_message.color=True
 process_event_message.last_node=None
+process_event_message.timestamp=""
 
 async def handle_log_rx(event):
     mc = handle_log_rx.mc
@@ -292,6 +306,57 @@ async def handle_log_rx(event):
                 else:
                     print(txt)
 
+    elif payload_type == 0x04: # Advert
+        if handle_log_rx.advert_echoes:
+            pk_buf = io.BytesIO(pkt_payload)
+            adv_key = pk_buf.read(32).hex()
+            adv_timestamp = int.from_bytes(pk_buf.read(4), "little", signed=False)
+            signature = pk_buf.read(64).hex()
+            flags = pk_buf.read(1)[0]
+            adv_type = flags & 0x0F
+            adv_lat = None
+            adv_lon = None
+            if flags & 0x10 > 0: #has location
+                adv_lat = int.from_bytes(pk_buf.read(4), "little", signed=True)/1000000.0
+                adv_lon = int.from_bytes(pk_buf.read(4), "little", signed=True)/1000000.0
+            if flags & 0x20 > 0: #has feature1
+                adv_feat1 = pk_buf.read(2).hex()
+            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")
+
+            if adv_name is None: 
+                # try to get the name from the contact 
+                ct = handle_log_rx.mc.get_contact_by_key_prefix(adv_key)
+                if ct is None:
+                    adv_name = adv_key[0:12]
+                else:
+                    adv_name = ct["adv_name"]
+
+            ts_string = ""
+            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"
+                    else:
+                        fmt = "%y-%m-%d %H:%S"
+                else:
+                    fmt = process_event_message.timestamp
+                ts_str = f' at {datetime.datetime.fromtimestamp(ts).strftime(fmt)}'
+
+            txt = f"{ANSI_LIGHT_GRAY}Advert for{ANSI_END} {adv_name}{ANSI_GREEN}/{CONTACT_TYPENAMES[adv_type]}{ts_str}{ANSI_END}"
+            if not adv_lat is None:
+                txt += f" {ANSI_LIGHT_GRAY}coords: {adv_lat},{adv_lon}"
+            txt += f" {ANSI_YELLOW}path: [{path}] {ANSI_LIGHT_GRAY}snr: {event.payload['snr']:.2f}dB{ANSI_END}"
+
+            if handle_message.above:
+                print_above(txt)
+            else:
+                print(txt)
+
+
     if handle_log_rx.json_log_rx: # json mode ... raw dump
         msg = json.dumps(event.payload)
         if handle_message.above:
@@ -302,6 +367,7 @@ async def handle_log_rx(event):
 
 handle_log_rx.json_log_rx = False
 handle_log_rx.channel_echoes = False
+handle_log_rx.advert_echoes = False
 handle_log_rx.mc = None
 handle_log_rx.echo_unk_chans=False
 
@@ -518,6 +584,7 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
         "self_telemetry" : None,
         "get_channel": None,
         "set_channel": None,
+        "add_channel": None,
         "get_channels": None,
         "remove_channel": None,
         "apply_to": None,
@@ -533,11 +600,13 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
             "lon" : None,
             "coords" : None,
             "print_snr" : {"on":None, "off": None},
+            "print_timestamp" : {"on":None, "off": None, "%Y:%M":None},
             "json_msgs" : {"on":None, "off": None},
             "color" : {"on":None, "off":None},
             "print_adverts" : {"on":None, "off":None},
             "json_log_rx" : {"on":None, "off":None},
             "channel_echoes" : {"on":None, "off":None},
+            "advert_echoes" : {"on":None, "off":None},
             "echo_unk_chans" : {"on":None, "off":None},
             "print_new_contacts" : {"on": None, "off":None},
             "print_path_updates" : {"on":None,"off":None},
@@ -562,11 +631,13 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
             "lat":None,
             "lon":None,
             "print_snr":None,
+            "print_timestamp":None,
             "json_msgs":None,
             "color":None,
             "print_adverts":None,
             "json_log_rx":None,
             "channel_echoes":None,
+            "advert_echoes":None,
             "echo_unk_chans":None,
             "print_path_updates":None,
             "print_new_contacts":None,
@@ -594,6 +665,12 @@ def make_completion_dict(contacts, pending={}, to=None, channels=None):
         "?pending_contacts":None,
         "?add_pending":None,
         "?flush_pending":None,
+        "?get_channels":None,
+        "?set_channel":None,
+        "?get_channel":None,
+        "?set_channel":None,
+        "?add_channel":None,
+        "?remove_channel":None,
     }
 
     contact_completion_list = {
@@ -1556,13 +1633,18 @@ async def get_channel (mc, chan) :
 
 async def set_channel (mc, chan, name, key=None):
 
-    if chan.isnumeric():
-        nb = int(chan)
+    if isinstance(chan, str):
+        if chan.isnumeric():
+            nb = int(chan)
+        else:
+            c = await get_channel_by_name(mc, chan)
+            if c is None:
+                return None
+            nb = c['channel_idx']
+    elif isinstance(chan, int):
+        nb = chan
     else:
-        c = await get_channel_by_name(mc, chan)
-        if c is None:
-            return None
-        nb = c['channel_idx']
+        return None
 
     res = await mc.commands.set_channel(nb, name, key)
 
@@ -1874,6 +1956,10 @@ async def next_cmd(mc, cmds, json_output=False):
                         process_event_message.color = (cmds[2] == "on")
                         if json_output :
                             print(json.dumps({"cmd" : cmds[1], "param" : cmds[2]}))
+                    case "print_timestamp" :
+                        process_event_message.timestamp = cmds[2]
+                        if json_output :
+                            print(json.dumps({"cmd" : cmds[1], "param" : cmds[2]}))
                     case "print_snr" :
                         process_event_message.print_snr = (cmds[2] == "on")
                         if json_output :
@@ -1886,6 +1972,10 @@ async def next_cmd(mc, cmds, json_output=False):
                         handle_log_rx.channel_echoes = (cmds[2] == "on")
                         if json_output :
                             print(json.dumps({"cmd" : cmds[1], "param" : cmds[2]}))
+                    case "advert_echoes" :
+                        handle_log_rx.advert_echoes = (cmds[2] == "on")
+                        if json_output :
+                            print(json.dumps({"cmd" : cmds[1], "param" : cmds[2]}))
                     case "echo_unk_chans" :
                         handle_log_rx.echo_unk_chans = (cmds[2] == "on")
                         if json_output :
@@ -2101,6 +2191,11 @@ async def next_cmd(mc, cmds, json_output=False):
                             print(json.dumps({"color" : process_event_message.color}))
                         else:
                             print(f"{'on' if process_event_message.color else 'off'}")
+                    case "print_timestamp":
+                        if json_output :
+                            print(json.dumps({"timestamp" : process_event_message.timestamp}))
+                        else:
+                            print(f"{process_event_message.timestamp}")
                     case "json_log_rx":
                         if json_output :
                             print(json.dumps({"json_log_rx" : handle_log_rx.json_log_rx}))
@@ -2111,6 +2206,11 @@ async def next_cmd(mc, cmds, json_output=False):
                             print(json.dumps({"channel_echoes" : handle_log_rx.channel_echoes}))
                         else:
                             print(f"{'on' if handle_log_rx.channel_echoes else 'off'}")
+                    case "advert_echoes":
+                        if json_output :
+                            print(json.dumps({"advert_echoes" : handle_log_rx.channel_echoes}))
+                        else:
+                            print(f"{'on' if handle_log_rx.advert_echoes else 'off'}")
                     case "echo_unk_chans":
                         if json_output :
                             print(json.dumps({"echo_unk_chans" : handle_log_rx.echo_unk_chans}))
@@ -2313,11 +2413,17 @@ 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])
+            case "add_channel":
+                argnum = 2
+                if cmds[1].startswith("#") or len(cmds) == 2:
+                    argnum = 1
+                    res = await set_channel(mc, "", cmds[1])
+                elif len(cmds[2]) != 32:
+                    res = None
+                else:
+                    res = await set_channel(mc, "", cmds[1], bytes.fromhex(cmds[3]))
                 if res is None:
-                    print(f"Error while setting scope")
+                    print("Error adding channel")
 
             case "remove_channel":
                 argnum = 1
@@ -2325,6 +2431,12 @@ async def next_cmd(mc, cmds, json_output=False):
                 if res is None:
                     print("Error deleting channel")
 
+            case "scope":
+                argnum = 1
+                res = await set_scope(mc, cmds[1])
+                if res is None:
+                    print(f"Error while setting scope")
+
             case "reboot" :
                 res = await mc.commands.reboot()
                 logger.debug(res)
@@ -3202,7 +3314,8 @@ def command_help():
     msgs_subscribe         : display msgs as they arrive            ms
     get_channels           : prints all channel info
     get_channel <n>        : get info for channel (by number or name)
-    set_channel n nm k     : set channel info (nb, name, key)
+    set_channel n nm [k]   : set channel info (nb, name, key)
+    add_channel name [key] : add new channel with optional key
     remove_channel <n>     : remove channel (by number or name)
     scope <s>              : sets scope for flood messages
   Management
@@ -3347,12 +3460,14 @@ def get_help_for (cmdname, context="line") :
       - when on contacts must be added manually using add_pending 
         (pending contacts list is built by meshcli from adverts while connected) 
   display:
+    print_timestamp <on/off/fmt>: toggle printing of timestamp, can be strftime format
     print_snr <on/off>          : toggle snr display in messages
     print_adverts <on/off>      : display adverts as they come
     print_new_contacts <on/off> : display new pending contacts when available
     print_path_updates <on/off> : display path updates as they come
     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)
     color <on/off>              : color off should remove ANSI codes from output
   meshcore-cli behaviour:
@@ -3397,6 +3512,30 @@ With growing number of users, it becomes necessary to manage contact list and on
 This feature only really works in interactive mode.
 
 Note: There is also an auto_update_contacts setting that has nothing to do with adding contacts, it permits to automatically sync contact lists between device and meshcore-cli (when there is an update in name, location or path).
+""")
+
+    elif "channel" in cmdname:
+        print("""Channel management
+
+Channels are used to send messages to a group of people. This group of people share a common key, used to encrypt, identify and decrypt the messages that are sent flood over the network (possibly with a scope).
+
+    Channel commands are the following:
+        - get_channels
+        - get_channel chan
+        - add_channel name [key]
+        - set_channel chan name [key]
+        - remove_channel chan
+
+There is a fixed number of slots on companions to store channel messages, each channel has a number, a name and a key, the get_channels command lists theses slots.
+
+You can also call get_channel (with number or name) to get information about one channel.
+
+Adding a channel can be done using the set_channel command, taking as parameters the channel number, the name and the key. Key is optional, if not provided, it will be computed from the name.
+ The add_channel command won't take a number as it will use first available slot.
+
+There is a special case for auto channels, which starts with a #, these have always their key computed from the name (note that mccli does not lowercase and strip characters so you should be carefull when sharing when users of the android app or ripple).
+
+To remove a channel, use remove_channel, either with channel name or number.
 """)
 
     else:
@@ -3537,7 +3676,14 @@ async def main(argv):
                 logger.info(f"Searching first MC BLE device")
             else:
                 logger.info(f"Scanning BLE for device matching {address}")
-            devices = await BleakScanner.discover(timeout=timeout)
+            try:
+                devices = await BleakScanner.discover(timeout=timeout)
+            except (BleakError, BleakDBusError):
+                print("BLE connection asked (default behaviour), but no BLE HW found")
+                print("Call meshcore-cli with -h for some more help (on commands)")
+                command_usage()
+                return            
+
             found = False
             for d in devices:
                 if not d.name is None and d.name.startswith("MeshCore-") and\

{meshcore_cli-1.3.7.dist-info → meshcore_cli-1.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meshcore-cli
-Version: 1.3.7
+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

meshcore_cli-1.3.8.dist-info/RECORD

@@ -0,0 +1,8 @@
+meshcore_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+meshcore_cli/__main__.py,sha256=PfYgibmu2LEtC-OV7L1UgmvV3swJ5rQ4bbXHlwUFlgE,83
+meshcore_cli/meshcore_cli.py,sha256=lBuixjTPVJm6ijXuB8RojArSjSDu6k8xCTOtpPAAgs4,158679
+meshcore_cli-1.3.8.dist-info/METADATA,sha256=PTtqAGUv5-37BMScJY5ErRy4gLFs9jIoBNbxnzSvgME,17137
+meshcore_cli-1.3.8.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+meshcore_cli-1.3.8.dist-info/entry_points.txt,sha256=77V29Pyth11GteDk7tneBN3MMk8JI7bTlS-BGSmxCmI,103
+meshcore_cli-1.3.8.dist-info/licenses/LICENSE,sha256=F9s987VtS0AKxW7LdB2EkLMkrdeERI7ICdLJR60A9M4,1066
+meshcore_cli-1.3.8.dist-info/RECORD,,

{meshcore_cli-1.3.7.dist-info → meshcore_cli-1.3.8.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

meshcore_cli-1.3.7.dist-info/RECORD

@@ -1,8 +0,0 @@
-meshcore_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-meshcore_cli/__main__.py,sha256=PfYgibmu2LEtC-OV7L1UgmvV3swJ5rQ4bbXHlwUFlgE,83
-meshcore_cli/meshcore_cli.py,sha256=iRrICDi9pCAngyuY6_Jc6teubgi4gomJ8l_NHXYNFrE,151869
-meshcore_cli-1.3.7.dist-info/METADATA,sha256=0o6ju0KlttNIOFoy3_0-rUEIlVwSymgsHDLkkr-So5w,17137
-meshcore_cli-1.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-meshcore_cli-1.3.7.dist-info/entry_points.txt,sha256=77V29Pyth11GteDk7tneBN3MMk8JI7bTlS-BGSmxCmI,103
-meshcore_cli-1.3.7.dist-info/licenses/LICENSE,sha256=F9s987VtS0AKxW7LdB2EkLMkrdeERI7ICdLJR60A9M4,1066
-meshcore_cli-1.3.7.dist-info/RECORD,,