add mozloc_signal to dump all current BSSID to CLI

Author: scivision

README.md

@@ -23,11 +23,17 @@ python -m pip install -e .
 ## Usage
 
 ```sh
-python MozLoc.py
+MozLoc
 ```
 
-Returns `dict()` containing `lat` `lng` `accuracy` `N BSSIDs heard`.
-In urban areas, accuracy ~ 5 - 100 meters.
+Shows `time` `lat` `lng` `accuracy` `N BSSIDs heard`.
+In urban areas, accuracy of less than 100 meters is possible.
+
+### dump raw signals
+
+```sh
+mozloc_signal
+```
 
 ### Windows
 

setup.cfg

@@ -49,4 +49,5 @@ io =
 [options.entry_points]
 console_scripts =
   MozLoc = mozloc.__main__:mozilla_location
+  mozloc_signal = mozloc.__main__:wifi_signal
   mozloc_csv2kml = mozloc.__main__:csv2kml

src/mozloc/__init__.py

@@ -1,2 +1,2 @@
 from .base import log_wifi_loc
-from .modules import get_cli, cli_config_check
+from .modules import get_signal, cli_config_check

src/mozloc/__main__.py

@@ -7,18 +7,30 @@
 
 Don't abuse the API or you'll get banned (excessive polling rate)
 """
+
 from .base import log_wifi_loc
+from .modules import get_signal
+
+import pandas
 from argparse import ArgumentParser
 
 
+def wifi_signal():
+
+    wifi = get_signal()
+    if isinstance(wifi, pandas.DataFrame):
+        print(wifi)
+    else:
+        # list of dict
+        for s in wifi:
+            print(s)
+
+
 def mozilla_location():
-    """
-    output: lat lon [deg] accuracy [m]
-    """
     p = ArgumentParser()
     p.add_argument("logfile", help="logfile to append location to", nargs="?")
     p.add_argument(
-        "-T", "--cadence", help="how often to ping [sec]. Some laptops cannot go faster than 30 sec.", default=60, type=float
+        "-T", "--cadence", help="how often to update [sec]. Some laptops cannot go faster than 30 sec.", default=60, type=float
     )
     p.add_argument(
         "-url",

src/mozloc/base.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 import logging
 
-from .modules import get_cli, cli_config_check
+from .modules import get_signal, cli_config_check
 from .web import get_loc_mozilla
 
 HEADER = "time                lat        lon         accuracy NumBSSIDs"
@@ -23,7 +23,7 @@ def log_wifi_loc(cadence_sec: float, mozilla_url: str, logfile: Path = None):
     # nmcli errored for less than about 0.2 sec.
     sleep(0.5)
     while True:
-        dat = get_cli()
+        dat = get_signal()
         if len(dat) < 2:
             logging.warning(f"cannot locate since at least 2 BSSIDs required\n{dat}")
             sleep(cadence_sec)

src/mozloc/modules.py

@@ -1,8 +1,8 @@
 import sys
 
 if sys.platform == "win32":
-    from .netsh import cli_config_check, get_cli
+    from .netsh import cli_config_check, get_signal
 elif sys.platform == "linux":
-    from .netman import cli_config_check, get_cli
+    from .netman import cli_config_check, get_signal
 else:
-    raise ImportError(f"MozLoc doesn't yet know how to work with platform {sys.platform}")
+    raise ImportError(f"MozLoc doesn't work with platform {sys.platform}")

src/mozloc/netman.py

@@ -38,7 +38,7 @@ def cli_config_check() -> bool:
     return False
 
 
-def get_cli() -> T.List[T.Dict[str, T.Any]]:
+def get_signal() -> T.List[T.Dict[str, T.Any]]:
 
     ret = subprocess.run(NMCMD, timeout=1.0)
     if ret.returncode != 0:

src/mozloc/netsh.py

@@ -27,7 +27,7 @@ def cli_config_check() -> bool:
     return False
 
 
-def get_cli() -> T.List[T.Dict[str, T.Any]]:
+def get_signal() -> T.List[T.Dict[str, T.Any]]:
     """ get signal strength using CLI """
     ret = subprocess.run(CMD, timeout=1.0, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
     if ret.returncode != 0:

src/mozloc/tests/test_netman.py

@@ -8,7 +8,7 @@
 def test_nm_loc():
 
     mozloc = pytest.importorskip('mozloc')
-    loc = mozloc.get_cli()
+    loc = mozloc.get_signal()
 
     assert isinstance(loc, list)
     assert isinstance(loc[0], dict)