generalize to use windows netsh or linux nmcli

mls requires at least 2 BSSID

Author: scivision

MozLoc.py

@@ -1,11 +1,11 @@
 #!/usr/bin/env python
 """
 https://mozilla.github.io/ichnaea/api/geolocate.html
+https://ichnaea.readthedocs.io/en/latest/api/geolocate.html
+
 you should get your own Mozilla Location Services API key
 
 Don't abuse the API or you'll get banned (excessive polling rate)
-
-Uses ``nmcli`` from Linux only. Could be extended to other tools and OS.
 """
 from mozloc import log_wifi_loc
 from argparse import ArgumentParser

README.md

@@ -1,62 +1,65 @@
+# Mozilla Location Services from Python
+
 [![Build Status](https://travis-ci.com/scivision/mozilla-location-wifi-python.svg?branch=master)](https://travis-ci.com/scivision/mozilla-location-wifi-python)
 [![Python versions (PyPI)](https://img.shields.io/pypi/pyversions/mozilla-location-python.svg)](https://pypi.python.org/pypi/mozilla-location-python)
 [![PyPi Download stats](http://pepy.tech/badge/mozilla-location-python)](http://pepy.tech/project/mozilla-location-python)
 
+Uses command line access to WiFi information in a short, simple Mozilla Location Services with Wifi from Python.
+The command line programs used to access WiFi inforamtion include:
 
-# mozilla-location-python
-Uses nmcli on Linux in a short, simple Mozilla Location Services with Wifi from Python.
-Goal was to be as simple as possible.
+* Linux: `nmcli` [NetworkManager](https://developer.gnome.org/NetworkManager/stable/nmcli.html)
+* Windows: [`netsh`](https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc755301(v=ws.10)?redirectedfrom=MSDN)
 
 Note that a similar service with better accuracy is available from
 [Google](https://developers.google.com/maps/documentation/geolocation/intro).
 Let us know if you're interested.
 
 ## Install
+
 ```sh
 python -m pip install -e .
 ```
 
-### prereqs
-Linux system with NetworkManager (e.g. Ubuntu, Raspberry Pi, etc.).
-
-
-
 ## Usage
+
 ```sh
-./MozLoc.py
+python MozLoc.py
 ```
 
 Returns `dict()` containing `lat` `lng` `accuracy` `N BSSIDs heard`.
 In urban areas, accuracy ~ 5 - 100 meters.
 
-
 ### convert to KML
-You can display your logged data in Google Earth or other KML value after converting by
 
-    ./csv2kml.py in.log out.kml
+Display logged data in Google Earth or other KML viewer after converting from CSV to KML:
 
-with
+```sh
+python csv2kml.py in.log out.kml
+```
 
-    pip install simplekml
+which uses
+
+```sh
+pip install simplekml
+```
 
 Note that your time MUST be in ISO 8601 format or some KML reading programs such as Google Earth will just show a blank file.
 E.g.
 
 2016-07-24T12:34:56
 
+## TODO
 
-## Contributing
-Pull request if you have another favorite approach.
-Would like to add Bluetooth, should be simple.
-
+Would like to add Bluetooth beacons.
 
 ## Notes
 
 * [Inspired by](https://github.com/flyinva/mozlosh)
 * [Alternative using Skyhook and geoclue](https://github.com/scivision/python-geoclue)
 * [Raspberry Pi NetworkManager](https://raspberrypi.stackexchange.com/a/73816)
 
-### Raspberry Pi 3 / Zero W
+### Raspberry Pi 3 / 4 / Zero W
+
 Debian comes without NetworkManager by default.
 Be careful as you lose Wifi password etc. by this procedure
 

mozloc/base.py

@@ -1,8 +1,13 @@
 from time import sleep
 from pathlib import Path
-
-from .netman import nm_config_check, get_nmcli
-
+import sys
+
+if sys.platform == "win32":
+    from .netsh import cli_config_check, get_cli
+elif sys.platform == "linux":
+    from .netman import cli_config_check, get_cli
+else:
+    raise ImportError(f"MozLoc doesn't yet know how to work with platform {sys.platform}")
 HEADER = "time lat lon accuracy NumBSSIDs"
 
 
@@ -16,10 +21,10 @@ def log_wifi_loc(T: float, logfile: Path):
     print(f"updating every {T} seconds")
     print(HEADER)
 
-    nm_config_check()
+    cli_config_check()
     sleep(0.5)  # nmcli errored for less than about 0.2 sec.
     while True:
-        loc = get_nmcli()
+        loc = get_cli()
         if loc is None:
             sleep(T)
             continue

mozloc/config.py

@@ -0,0 +1 @@
+URL = "https://location.services.mozilla.com/v1/geolocate?key=test"

mozloc/netman.py

@@ -9,25 +9,26 @@
 import requests
 from datetime import datetime
 
+from .config import URL
+
 NMCLI = shutil.which("nmcli")
 if not NMCLI:
-    raise ImportError('This program relies on NetworkManager via "nmcli"')
+    raise ImportError('Could not find NetworkManager "nmcli"')
 
-URL = "https://location.services.mozilla.com/v1/geolocate?key=test"
 NMCMD = [NMCLI, "-g", "SSID,BSSID,FREQ,SIGNAL", "device", "wifi"]  # Debian stretch, Ubuntu 18.04
 NMLEG = [NMCLI, "-t", "-f", "SSID,BSSID,FREQ,SIGNAL", "device", "wifi"]  # ubuntu 16.04
 NMSCAN = [NMCLI, "device", "wifi", "rescan"]
 
 
-def nm_config_check():
+def cli_config_check():
     # %% check that NetworkManager CLI is available and WiFi is active
     ret = subprocess.check_output([NMCLI, "-t", "radio", "wifi"], universal_newlines=True, timeout=1.0).strip().split(":")
 
     if "enabled" not in ret and "disabled" in ret:
         raise ConnectionError("must enable WiFi, perhaps via nmcli radio wifi on")
 
 
-def get_nmcli() -> typing.Dict[str, typing.Any]:
+def get_cli() -> typing.Dict[str, typing.Any]:
 
     ret = subprocess.run(NMCMD, timeout=1.0)
     if ret.returncode != 0:
@@ -51,6 +52,9 @@ def get_nmcli() -> typing.Dict[str, typing.Any]:
     )
     # %% optout
     dat = dat[~dat["ssid"].str.endswith("_nomap")]
+    if dat.shape[0] < 2:
+        logging.warning("cannot locate since at least 2 BSSIDs required")
+        return None
     # %% cleanup
     dat["ssid"] = dat["ssid"].str.replace("nan", "")
     dat["macAddress"] = dat["macAddress"].str.replace(r"\\:", ":")

mozloc/netsh.py

@@ -0,0 +1,106 @@
+""" Network Manager CLI (nmcli) functions """
+import subprocess
+import typing
+import logging
+import shutil
+import io
+import requests
+import json
+from math import log10
+from datetime import datetime
+
+from .config import URL
+
+CLI = shutil.which("netsh")
+if not CLI:
+    raise ImportError('Could not find NetSH "netsh"')
+
+CMD = [CLI, "wlan", "show", "networks", "mode=bssid"]
+
+
+def cli_config_check():
+    # %% check that NetSH CLI is available and WiFi is active
+    ret = subprocess.check_output(CMD, universal_newlines=True, timeout=1.0)
+    for line in ret.split("\n"):
+        if "networks currently visible" in line:
+            return
+        if "The wireless local area network interface is powered down and doesn't support the requested operation" in line:
+            raise ConnectionError("must enable WiFi, it appears to be turned off.")
+    logging.error("could not determine WiFi state.")
+
+
+def get_cli() -> typing.Dict[str, typing.Any]:
+    """ get signal strength using CLI """
+    ret = subprocess.run(CMD, timeout=1.0, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
+    if ret.returncode != 0:
+        logging.error(f"consider slowing scan cadence.  {ret.stderr}")
+
+    dat: typing.List[typing.Dict[str, str]] = []
+    out = io.StringIO(ret.stdout)
+    for line in out:
+        d: typing.Dict[str, str] = {}
+        if not line.startswith("SSID"):
+            continue
+        ssid = line.split(":", 1)[1].strip()
+        # optout
+        if ssid.endswith("_nomap"):
+            continue
+        # find BSSID MAC address
+        for line in out:
+            if not line[4:9] == "BSSID":
+                continue
+            d["macAddress"] = line.split(":", 1)[1].strip()
+            for line in out:
+                if not line[9:15] == "Signal":
+                    continue
+                signal_percent = int(line.split(":", 1)[1][:3])
+                d["signalStrength"] = str(signal_percent_to_dbm(signal_percent))
+                d["ssid"] = ssid
+                dat.append(d)
+                d = {}
+                break
+    if len(dat) < 2:
+        logging.warning("cannot locate since at least 2 BSSIDs required")
+        return None
+    # %% JSON
+    jdat = json.dumps(dat)
+    jdat = '{ "wifiAccessPoints":' + jdat + "}"
+    logging.debug(jdat)
+    # %% cloud MLS
+    try:
+        req = requests.post(URL, data=jdat)
+        if req.status_code != 200:
+            logging.error(req.text)
+            return None
+    except requests.exceptions.ConnectionError as e:
+        logging.error(f"no network connection.  {e}")
+        return None
+    # %% process MLS response
+    jres = req.json()
+    loc = jres["location"]
+    loc["accuracy"] = jres["accuracy"]
+    loc["N"] = len(dat)  # number of BSSIDs used
+    loc["t"] = datetime.now()
+
+    return loc
+
+
+def signal_percent_to_dbm(percent: int) -> int:
+    """ arbitrary conversion factor from Windows WiFi signal % to dBm
+    assumes 100% is -30 dBm
+
+    Parameters
+    ----------
+    percent: int
+        signal strength as percent 0..100
+
+    Returns
+    -------
+    meas_dBm: int
+        truncate to nearest integer because of uncertainties
+    """
+    REF = -30  # dBm
+    ref_mW = 10 ** (REF / 10) / 1000
+    meas_mW = max(ref_mW * percent / 100, 1e-7)
+    meas_dBm = 10 * log10(meas_mW) + 30
+    return int(meas_dBm)

tests/test_all.py

@@ -8,7 +8,7 @@ def test_nm_loc():
     mozloc = pytest.importorskip("mozloc")
 
     try:
-        loc = mozloc.netman.get_nmcli()
+        loc = mozloc.netman.get_cli()
     except subprocess.CalledProcessError as e:
         pytest.skip(f"problem with NMCLI API--old NMCLI version?  {e}")
 
@@ -20,7 +20,7 @@ def test_nm_connection():
     mozloc = pytest.importorskip("mozloc")
 
     try:
-        mozloc.netman.nm_config_check()
+        mozloc.netman.cli_config_check()
     except subprocess.CalledProcessError as e:
         pytest.skip(f"problem with NMCLI WiFi API--do you have WiFi?  {e}")