add macos via airport

Author: scivision

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = mozloc
-version = 1.1.2
+version = 1.2.0
 author = Michael Hirsch, Ph.D.
 author_email = scivision@users.noreply.github.com
 url = https://github.com/scivision/mozilla-location-wifi
@@ -14,6 +14,7 @@ classifiers =
   Intended Audience :: Information Technology
   Intended Audience :: System Administrators
   Operating System :: POSIX :: Linux
+  Operating System :: MacOS
   Operating System :: Microsoft :: Windows
   Programming Language :: Python :: 3
   Topic :: System :: Networking

src/mozloc/airport.py

@@ -0,0 +1,54 @@
+""" MacOS airport functions """
+
+from __future__ import annotations
+import typing as T
+import shutil
+import io
+import logging
+import subprocess
+import re
+
+EXE = shutil.which("airport", path="/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources")
+if not EXE:
+    raise ImportError("Could not find Airport")
+
+
+def cli_config_check() -> bool:
+    # %% check that Airport is available and WiFi is active
+    ret = subprocess.run([EXE, "--getinfo"], stdout=subprocess.PIPE, text=True, timeout=30)
+
+    if ret.returncode != 0:
+        return False
+
+    stdout = ret.stdout.strip().lower()
+    if len(stdout) == "airport: off":
+        return False
+
+    if "state: running" in stdout:
+        return True
+
+    logging.error("could not determine WiFi state.")
+    return False
+
+
+def get_signal() -> list[dict[str, T.Any]]:
+
+    ret = subprocess.run([EXE, "-s"], timeout=30.0, stdout=subprocess.PIPE, text=True)
+
+    if ret.returncode != 0:
+        logging.error("consider slowing scan cadence.")
+
+    pat = re.compile(r"\s*([0-9a-zA-Z\-\.]+)\s+([0-9a-f]{2}(?::[0-9a-f]{2}){5})\s+(-\d{2,3})")
+    dat: list[dict[str, str]] = []
+
+    for line in io.StringIO(ret.stdout):
+        mat = pat.match(line)
+        if mat:
+            ssid = mat.group(1)
+            # optout
+            if ssid.endswith("_nomap"):
+                continue
+
+            dat.append({"ssid": ssid, "macAddress": mat.group(2), "signalStrength": mat.group(3)})
+
+    return dat

src/mozloc/base.py

@@ -28,6 +28,7 @@ def log_wifi_loc(cadence_sec: float, mozilla_url: str, logfile: Path = None):
             logging.warning(f"cannot locate since at least 2 BSSIDs required\n{dat}")
             sleep(cadence_sec)
             continue
+        print(dat)
 
         loc = get_loc_mozilla(dat, mozilla_url)
         if loc is None:

src/mozloc/modules.py

@@ -4,5 +4,7 @@
     from .netsh import cli_config_check, get_signal
 elif sys.platform == "linux":
     from .netman import cli_config_check, get_signal
+elif sys.platform == "darwin":
+    from .airport import cli_config_check, get_signal
 else:
     raise ImportError(f"MozLoc doesn't work with platform {sys.platform}")

src/mozloc/netman.py

@@ -1,10 +1,12 @@
 """ Network Manager CLI (nmcli) functions """
+
+from __future__ import annotations
+import typing as T
 import subprocess
 import logging
 import shutil
 import pandas
-import typing as T
-from io import StringIO
+import io
 from time import sleep
 
 NMCLI = shutil.which("nmcli")
@@ -38,19 +40,19 @@ def cli_config_check() -> bool:
     return False
 
 
-def get_signal() -> T.List[T.Dict[str, T.Any]]:
+def get_signal() -> list[dict[str, T.Any]]:
 
     ret = subprocess.run(NMCMD, timeout=1.0)
     if ret.returncode != 0:
         raise ConnectionError("could not connect with NetworkManager for WiFi")
     sleep(0.5)  # nmcli errored for less than about 0.2 sec.
     # takes several seconds to update, so do it now.
-    ret = subprocess.run(NMSCAN, timeout=1.0, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+    ret = subprocess.run(NMSCAN, timeout=1.0, stdout=subprocess.PIPE, text=True)
     if ret.returncode != 0:
-        logging.error(f"consider slowing scan cadence.  {ret.stderr}")
+        logging.error("consider slowing scan cadence.")
 
     dat = pandas.read_csv(
-        StringIO(ret.stdout),
+        io.StringIO(ret.stdout),
         sep=r"(?<!\\):",
         index_col=False,
         header=0,

src/mozloc/netsh.py

@@ -1,6 +1,8 @@
 """ Windows NetSH functions """
-import subprocess
+
+from __future__ import annotations
 import typing as T
+import subprocess
 import logging
 import shutil
 import io
@@ -27,16 +29,16 @@ def cli_config_check() -> bool:
     return False
 
 
-def get_signal() -> T.List[T.Dict[str, T.Any]]:
+def get_signal() -> list[dict[str, T.Any]]:
     """ get signal strength using CLI """
-    ret = subprocess.run(CMD, timeout=1.0, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+    ret = subprocess.run(CMD, timeout=1.0, stdout=subprocess.PIPE, text=True)
     if ret.returncode != 0:
-        logging.error(f"consider slowing scan cadence.  {ret.stderr}")
+        logging.error("consider slowing scan cadence.")
 
-    dat: T.List[T.Dict[str, str]] = []
+    dat: list[dict[str, str]] = []
     out = io.StringIO(ret.stdout)
     for line in out:
-        d: T.Dict[str, str] = {}
+        d: dict[str, str] = {}
         if not line.startswith("SSID"):
             continue
         ssid = line.split(":", 1)[1].strip()