functionalize, package

Author: scivision

.gitignore

@@ -1,3 +1,6 @@
+*.log
+*.txt
+*.csv
 *.kml
 # Byte-compiled / optimized / DLL files
 __pycache__/

MozLoc.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+"""
+https://mozilla.github.io/ichnaea/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 logwifiloc
+
+
+if __name__ == '__main__':
+    """
+    output: lat lon [deg] accuracy [m]
+    """
+    import signal
+    signal.signal(signal.SIGINT, signal.SIG_DFL)
+
+    from argparse import ArgumentParser
+    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)
+    p = p.parse_args()
+
+
+    logwifiloc(p.cadence, p.logfile)

README.md

@@ -3,29 +3,33 @@ Uses nmcli on Linux in a short, simple Mozilla Location Services with Wifi from
 Goal was to be as simple as possible.
 Works with Python 2.7 and 3.
 
-## prereqs
+## Install
+```sh
+python -m pip install -e .
+```
+
+### prereqs
 Linux system with NetworkManager (e.g. Ubuntu, Raspberry Pi, etc.).
 
-    pip install pandas requests
 
 
 ## Usage
 
     ./mozloc.py
 
-Returns `dict` containing `lat` `lng` `accuracy`.
-In urban areas, accuracy ~ 100 meters.
+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
-    
+
 with
-    
+
     pip install simplekml
-    
+
 
 ## Contributing
 Pull request if you have another favorite approach.
@@ -42,9 +46,9 @@ Would like to add Bluetooth, should be simple.
 Debian comes without NetworkManager by default.
 Be careful as you lose Wifi password etc. by this procedure
 
-1. Install network manager and remove the old 
+1. Install network manager and remove the old
    ```sh
-   sudo apt install network-manager   
+   sudo apt install network-manager
    sudo apt purge dhcpcd5
    ```
    reboot

csv2kml.py

@@ -1,32 +1,6 @@
 #!/usr/bin/env python
 """convert logged positions to KML"""
-import numpy as np
-from simplekml import Kml
-
-def makekml(t, lonLatAlt, ofn):
-    """
-    write KML track/positions
-
-    t: vector of times
-    lonLatAlt: longitude, latitude, altitude or just lon,lat
-    ofn: KML filename to create
-    """
-    lonLatAlt = np.asarray(lonLatAlt)
-    assert lonLatAlt.ndim==2 and lonLatAlt.shape[1] in (2,3), 'Expect Nx2 or Nx3 array'
-
-    kml = Kml(name='My Kml',open=1)
-
-    if t is not None: # track over time
-        trk = kml.newgxtrack(name='My Track')
-        trk.newwhen(t)
-        trk.newgxcoord(lonLatAlt.tolist()) #list of lon,lat,alt, NOT ndarray!
-    else: # just a bunch of points
-        for i,p in enumerate(lonLatAlt): # iterate over rows
-            kml.newpoint(name=str(i), coords=[p])
-
-    print('writing',ofn)
-    kml.save(ofn)
-
+from mozloc import csv2kml
 
 if __name__ == '__main__':
     from argparse import ArgumentParser
@@ -35,6 +9,5 @@ def makekml(t, lonLatAlt, ofn):
     p.add_argument('kmlfn',help='kml filename to write')
     p = p.parse_args()
 
-    dat = np.fliplr(np.loadtxt(p.logfn, usecols=(1,2)))
 
-    makekml(None,dat,p.kmlfn)
+    csv2kml(p.logfn, p.kmlfn)

mozloc.py

@@ -0,0 +1,119 @@
+import subprocess
+import logging
+from io import StringIO
+import pandas
+import requests
+from datetime import datetime
+from time import sleep
+from pathlib import Path
+#
+URL='https://location.services.mozilla.com/v1/geolocate?key=test'
+NMCMD = ['nmcli','-g','SSID,BSSID,FREQ,SIGNAL','device','wifi'] # Debian stretch, Ubuntu 17.10
+NMLEG = ['nmcli','-t','-f','SSID,BSSID,FREQ,SIGNAL','device','wifi'] # ubuntu 16.04
+NMSCAN = ['nmcli','device','wifi','rescan']
+HEADER='time lat lon accuracy NumBSSIDs'
+
+
+def logwifiloc(T:float, logfile:Path):
+
+    if logfile:
+        logfile = Path(logfile).expanduser()
+        with logfile.open('a') as f:
+            f.write(HEADER+'\n')
+
+
+    print(f'updating every {T} seconds')
+    print(HEADER)
+    while True:
+        loc = get_nmcli()
+        if loc is None:
+            sleep(T)
+            continue
+
+        stat = f'{loc["t"].strftime("%xT%X")} {loc["lat"]} {loc["lng"]} {loc["accuracy"]:.1f} {loc["N"]:02d}'
+        print(stat)
+
+        if logfile:
+            with logfile.open('a') as f:
+                f.write(stat+'\n')
+
+        sleep(T)
+
+
+def get_nmcli():
+
+
+    ret = subprocess.check_output(NMLEG, universal_newlines=True)
+    sleep(0.5) # nmcli crashed for less than about 0.2 sec.
+    try:
+        subprocess.check_call(NMSCAN) # takes several seconds to update, so do it now.
+    except subprocess.CalledProcessError as e:
+        logging.error(f'consider slowing scan cadence.  {e}')
+
+    dat = pandas.read_csv(StringIO(ret), sep=r'(?<!\\):', index_col=False,
+                          header=0, encoding='utf8', engine='python',
+                          dtype=str, usecols=[0,1,3],
+                          names=['ssid','macAddress','signalStrength'])
+# %% optout
+    dat = dat[~dat['ssid'].str.endswith('_nomap')]
+# %% cleanup
+    dat['ssid'] = dat['ssid'].str.replace('nan','')
+    dat['macAddress'] = dat['macAddress'].str.replace(r'\\:',':')
+# %% JSON
+    jdat = dat.to_json(orient='records')
+    jdat = '{ "wifiAccessPoints":' + jdat + '}'
+#    print(jdat)
+# %% cloud MLS
+    try:
+        req = requests.post(URL, data=jdat)
+        if req.status_code != 200:
+            logging.error(req.text)
+            return
+    except requests.exceptions.ConnectionError as e:
+        logging.error(f'no network connection.  {e}')
+        return
+# %% process MLS response
+    jres = req.json()
+    loc = jres['location']
+    loc['accuracy'] = jres['accuracy']
+    loc['N'] = dat.shape[0] # number of BSSIDs used
+    loc['t'] = datetime.now()
+
+    return loc
+# %%
+
+def csv2kml(csvfn:Path, kmlfn:Path):
+    from simplekml import Kml
+
+    """
+    write KML track/positions
+
+    t: vector of times
+    lonLatAlt: longitude, latitude, altitude or just lon,lat
+    ofn: KML filename to create
+    """
+
+    # lon, lat
+    dat = pandas.read_csv(csvfn, sep=' ', index_col=0, header=0)
+
+    t = dat.index.tolist()
+    lla = dat.loc[:,['lon','lat']].values
+# %% write KML
+    """
+    http://simplekml.readthedocs.io/en/latest/geometries.html#gxtrack
+    """
+    kml = Kml(name='My Kml',open=1)
+
+
+    doc = kml.newdocument(name='Mozilla Location Services')
+    fol = doc.newfolder(name='Tracks')
+    trk = fol.newgxtrack(name='My Track')
+    trk.newwhen(t)  # list of times
+    trk.newgxcoord(lla.tolist()) #list of lon,lat,alt, NOT ndarray!
+
+# just a bunch of points
+#        for i,p in enumerate(lla): # iterate over rows
+#            kml.newpoint(name=str(i), coords=[p])
+
+    print('writing', kmlfn)
+    kml.save(kmlfn)

mozloc/__init__.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+install_requires = ['pandas','requests']
+tests_require = ['nose','coveralls']
+# %%
+from setuptools import setup,find_packages
+
+setup(name='mozilla-location-python',
+      packages=find_packages(),
+      author='Michael Hirsch, Ph.D.',
+      url='https://github.com/scivision/mozilla-location-python',
+      long_description=open('README.md').read(),
+      description='Using Mozilla Location services, log location vs. time using WiFi or convert to KML.',
+      install_requires=install_requires,
+      tests_require=tests_require,
+      extras_require={'tests':tests_require,
+                      'kml':['simplekml']},
+      python_requires='>=3.6',
+	  )
+