New version added v1.1.3

# Conflicts:
#	package.json

.gitignore

@@ -1,2 +1,3 @@
 .idea
 node_modules
+/yarn.lock

.travis.yml

@@ -4,5 +4,5 @@ branches:
     - master
     - develop
 node_js:
-   - "4"
-   - "5"
+   - "10"
+   - "11"

README.md

@@ -13,8 +13,6 @@ The module was inspired from Maurice Sways "[node-wifiscanner](https://github.co
 had to handle much more complex network environments and also wanted to be independent of the operating
 system language. The adaptions needed would have been too comprehensive for a pull request so I decided to write an own module.
 
-**The module is currently in BETA testing, changes in functionality and interface are possible. Please report bugs on the projects GitHub page, Thanks!**
-
 ## Operating Systems
 
 It was tested with the following operating systems:
@@ -29,6 +27,12 @@ It was tested with the following operating systems:
 
 ## Usage
 
+### Command Line
+
+Run the script ```scan``` in the bin folder.
+
+### Code
+
     const scanner = require('node-wifi-scanner');
 
     scanner.scan((err, networks) => {
@@ -43,7 +47,7 @@ The tool returns an array with objects, each object representing a network with
 
 * channel: WiFi channel
 * ssid: SSID of the network (if available)
-* mac: MAC Address of the network access point
+* mac: MAC Address of the network access point (if available, otherwise empty string)
 * rssi: signal strength
 
 In contrary to other wifi scanners no information about security is returned. This is due to the very different implementation
@@ -55,13 +59,29 @@ The module uses command line tools for gathering the network information:
 
 * airport on Mac OS-X: `airport -s`
 * netsh on Windows: `netsh wlan show networks mode=Bssid`
-* iwlist (1st choice) on Linux: `iwlist scan`
-* nmcli (fallback only) on Linux: `nmcli -m tabular -f SSID,BSSID,SIGNAL,FREQ device wifi`
+* iwlist on Linux: `iwlist scan`
+
 
 Unfortunately, Mac OS-X and Windows use the system language for the output which requires a quite
 generic way of parsing the data. If you experience any troubles, please create a GitHub issue and supply
 the output of the tool.
 
+## Limits of the tool
+
+There is no such thing as perfect software  and this is all the more true when the tools used require different 
+access rights depending on
+the operating system. Please note the following restrictions 
+before using this tool in a productive system.
+
+**Linux**: iwlist does only return all found networks if run as sudo! Otherwise you'll
+get only the network you're connected to.
+
+**Windows**: there are some network cards which do not 
+return the MAC address and other parameters of the found networks. In this case
+the "found" networks are ignored as there is no valuable data. If you have this effect
+on your system, please provide as many information about your system (PC manufacturer, network
+card, OS,...) as available. Thanks
+
 ## Licence
 
 The MIT License (MIT)

bin/scan

@@ -5,7 +5,7 @@
  * Created by kc on 04.04.16.
  */
 
-var scanner = require('../index');
+const scanner = require('../index');
 
 scanner.scan((err, output) => {
   if (err) {
@@ -13,4 +13,4 @@ scanner.scan((err, output) => {
     return;
   }
   console.log(output);
-});
+});

index.js

@@ -3,45 +3,62 @@
  * Created by kc on 04.04.16.
  */
 
-const fs      = require('fs');
 const exec    = require('child_process').exec;
+const async   = require('async');
+const _       = require('lodash');
 // The tools
 const airport = require('./lib/airport');
 const iwlist  = require('./lib/iwlist');
-const nmcli   = require('./lib/nmcli');
 const netsh   = require('./lib/netsh');
 
-var scanner;
+let scanner;
 
 // Initializing the tools
 function initTools(callback) {
-  fs.stat(airport.tool, function (err, stats) {
-    if (stats) {
-      return callback(null, airport);
-    }
 
-    fs.stat(iwlist.tool, function (err, stats) {
-      if (stats) {
-        return callback(null, iwlist);
-      }
-
-      fs.stat(nmcli.tool, function (err, stats) {
-        if (stats) {
-          return callback(null, nmcli);
-        }
-
-        fs.stat(netsh.tool, function (err, stats) {
-          if (stats) {
-            return callback(null, netsh);
+  // When a command is not found, an error is issued and async would finish. Therefore we pack
+  // the error into the result and check it later on.
+  async.parallel([
+      function (cb) {
+        exec(airport.detector, function (err) {
+            cb(null, {err: err, scanner: airport}
+            )
           }
-
-          callback(new Error('No scanner found'));
+        );
+      },
+      function (cb) {
+        exec(iwlist.detector, function (err) {
+            cb(null, {err: err, scanner: iwlist}
+            )
+          }
+        );
+      },
+      function (cb) {
+        exec(netsh.detector, function (err) {
+            cb(null, {err: err, scanner: netsh}
+            )
+          }
+        );
+      }
+    ],
+    function (err, results) {
+      let res = _.find(results,
+        function (f) {
+          return !f.err
         });
-      });
-    });
-  });
+
+      if (res) {
+        return callback(null, res.scanner);
+      }
+      callback(new Error('No scanner found'));
+    }
+  );
 }
 
+/**
+ * Scan the networks with the scanner detected before
+ * @param callback
+ */
 function scanNetworks(callback) {
   exec(scanner.cmdLine, function (err, stdout) {
     if (err) {
@@ -59,7 +76,7 @@ module.exports = {
    */
   scan: function (callback) {
     if (!scanner) {
-      initTools((err, s) => {
+      initTools(function (err, s) {
         if (err) {
           return callback(err);
         }
@@ -70,4 +87,4 @@ module.exports = {
     }
     scanNetworks(callback);
   }
-};
+};

lib/airport.js

@@ -3,47 +3,45 @@
  * Created by kc on 04.04.16.
  */
 
-const tool    = '/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport';
-const cmdLine = tool + ' -s';
+const tool     = '/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport';
+const cmdLine  = tool + ' -s';
+const detector = tool + ' -getInfo';
 
-const macRegex = /([0-9a-zA-Z]{1}[0-9a-zA-Z]{1}[:]{1}){5}[0-9a-zA-Z]{1}[0-9a-zA-Z]{1}/;
 /**
  * Parsing the output of airport (Mac OS X)
  * @param str output of the tool
  * @param callback
  */
 function parseOutput(str, callback) {
-  var err = null;
+  let err   = null;
+  let wifis = [];
 
   try {
-    var lines      = str.split('\n');
-    var wifis = [];
-    
-    for (var i = 1, l = lines.length; i < l; i++) {
-      var mac = lines[i].match(macRegex);
-      if (!mac) {
-        continue;
-      }
-      var macStart = lines[i].indexOf(mac[0]);
-      var elements = lines[i].substr(macStart).split(/[ ]+/);
+    let lines = str.split('\n');
+
+    for (let i = 1, l = lines.length; i < l; i++) {
+      if (lines[i] === '') continue;
+      let elements = lines[i].substring(51).split(/[ ]+/);
       wifis.push({
-        'ssid'    : lines[i].substr(0, macStart).trim(),
-        'mac'     : elements[0].trim(),
-        'channel' : parseInt(elements[2].trim(), 10),
-        'rssi'    : parseInt(elements[1].trim())
+        'ssid'   : lines[i].substring(0, 32).trim(),
+        'mac'    : '',  // There is no more mac on a mac
+        'channel': parseInt(elements[1].trim(), 10),
+        'rssi'   : parseInt(elements[0].trim(), 10)
       });
     }
   }
   catch (ex) {
     err = ex;
   }
-
-  callback(err, wifis);
+  finally {
+    callback(err, wifis);
+  }
 }
 
 
 module.exports = {
   parseOutput: parseOutput,
   cmdLine    : cmdLine,
+  detector   : detector,
   tool       : tool
 };

lib/iwlist.js

@@ -3,27 +3,32 @@
  * Created by kc on 04.04.16.
  */
 
-const _       = require('lodash');
-const tool    = '/usr/bin/iwlist';
-const cmdLine = tool + ' scan';
+const _ = require('lodash');
+// usually located in /usr/bin/ but as it could be at another location, allow all found in PATH (but we're in trouble
+// when the default location, /usr/bin/ is not in the PATH!). GitHub issue #1
+const tool     = 'iwlist';
+const cmdLine  = tool + ' scan';
+const detector = tool + ' --help';
+
 
 const macRegex  = /([0-9a-zA-Z]{1}[0-9a-zA-Z]{1}[:]{1}){5}[0-9a-zA-Z]{1}[0-9a-zA-Z]{1}/;
 const cellRegex = /Cell [0-9]{2,} - Address:/;
+
 /**
  * Parsing the output of iwlist, tool having a lot of different faces :-(
  * @param str output of the tool
  * @param callback
  */
 function parseOutput(str, callback) {
-  var err   = null;
-  var wifis = [];
+  let err   = null;
+  let wifis = [];
 
   try {
-    var blocks = str.split(cellRegex);
+    let blocks = str.split(cellRegex);
 
     blocks.forEach(block => {
-      var network = {};
-      var lines   = block.split('\n');
+      let network = {};
+      let lines   = block.split('\n');
       if (macRegex.exec(lines[0])) {
         // First line is the mac address (always! (?))
         network.mac = lines[0].trim();
@@ -39,25 +44,24 @@ function parseOutput(str, callback) {
           }
 
           // Channel, an ugly thing to get it
-          else if (_.startsWith(line.trim(), 'Frequency:')) {
-            network.channel = parseInt(_.trim(line, ' )').split(/Channel/)[1], 10);
+          else if (_.startsWith(line.trim(), 'Channel:')) {
+            network.channel = parseInt(_.trim(line, ' )').split(/:/)[1]);
           }
-            
+
           // Another ugly thing, the signal which can have different formats, even worse als
           // having different identifiers
           else if (line.indexOf('Signal level') > -1) {
             if (line.indexOf('Quality') > -1) {
               // This is a "Quality=40/70  Signal level=-70 dBm" line
               network.rssi = parseInt(line.substr(line.indexOf('Signal level') + 13), 10);
-            }
-            else {
+            } else {
               // This is a "Signal level=60/100" line
-              var elements = line.split('=');
+              let elements = line.split('=');
               elements.forEach(e => {
                 if (e.indexOf('/') > 0) {
                   // that's our part
-                  var parts    = e.split('/');
-                  var level    = Math.floor(100 * parseInt(parts[0], 10) / parseInt(parts[1], 10));
+                  let parts    = e.split('/');
+                  let level    = Math.floor(100 * parseInt(parts[0], 10) / parseInt(parts[1], 10));
                   network.rssi = level / 2 - 100;
                 }
               })
@@ -79,5 +83,6 @@ function parseOutput(str, callback) {
 module.exports = {
   parseOutput: parseOutput,
   cmdLine    : cmdLine,
+  detector   : detector,
   tool       : tool
 };

lib/netsh.js

@@ -6,6 +6,7 @@
 const systemRoot = process.env.SystemRoot || 'C:\\Windows';
 const tool       = systemRoot + '\\System32\\netsh.exe';
 const cmdLine    = tool + ' wlan show networks mode=Bssid';
+const detector   = tool + ' show alias';
 
 /**
  * Parsing netnsh output. Unfortunately netsh supplies the network information
@@ -14,9 +15,9 @@ const cmdLine    = tool + ' wlan show networks mode=Bssid';
  * an approach of analyzing the structure of the output
  */
 function parseOutput(str, callback) {
-  var blocks = str.split('\n\n');
-  var wifis  = [];
-  var err    = null;
+  let blocks = str.split('\n\n');
+  let wifis  = [];
+  let err    = null;
   try {
     if (blocks.length < 2) {
       // 2nd try, with \r\n
@@ -39,18 +40,18 @@ function parseOutput(str, callback) {
     //          Channel              : 6
     //          Basic rates (MBit/s) : 1 2 5.5 11
     //          Other rates (MBit/s) : 6 9 12 18 24 36 48 54
-    for (var i = 1, l = blocks.length; i < l; i++) {
-      var network      = {};
-      var lines        = blocks[i].split('\n');
-      var regexChannel = /[a-zA-Z0-9()\s]+:[\s]*[0-9]+$/g;
+    for (let i = 1, l = blocks.length; i < l; i++) {
+      let network      = {};
+      let lines        = blocks[i].split('\n');
+      let regexChannel = /[a-zA-Z0-9()\s]+:[\s]*[0-9]+$/g;
       if (!lines || lines.length < 2) {
         continue;
       }
 
       // First line is always the SSID (which can be empty)
-      var ssid = lines[0].substring(lines[0].indexOf(':') + 1).trim();
+      let ssid = lines[0].substring(lines[0].indexOf(':') + 1).trim();
 
-      for (var t = 1, n = lines.length; t < n; t++) {
+      for (let t = 1, n = lines.length; t < n; t++) {
         if (lines[t].split(':').length === 7) {
           // This is the mac address, use this one as trigger for a new network
           if (network.mac) {
@@ -60,18 +61,16 @@ function parseOutput(str, callback) {
             ssid: ssid,
             mac : lines[t].substring(lines[t].indexOf(':') + 1).trim()
           };
-        }
-        else if (lines[t].indexOf('%') > 0) {
+        } else if (lines[t].indexOf('%') > 0) {
           // Network signal strength, identified by '%'
-          var level = parseInt(lines[t].split(':')[1].split('%')[0].trim(), 10);
+          let level = parseInt(lines[t].split(':')[1].split('%')[0].trim(), 10);
 
           network.rssi = (level / 2) - 100;
-        }
-        else if (!network.channel) {
+        } else if (!network.channel) {
           // A tricky one: the channel is the first one having just ONE number. Set only
           // if the channel is not already set ("Basic Rates" can be a single number also)
           if (regexChannel.exec(lines[t].trim())) {
-            network.channel = parseInt(lines[t].split(':')[1].trim());
+            network.channel = parseInt(lines[t].split(':')[1].trim(), 10);
           }
         }
       }
@@ -90,5 +89,6 @@ function parseOutput(str, callback) {
 module.exports = {
   parseOutput: parseOutput,
   cmdLine    : cmdLine,
+  detector   : detector,
   tool       : tool
 };

lib/nmcli.js

@@ -1,50 +0,0 @@
-/**
- * Scanning WiFis on Mac OS X using nmcli
- * Created by kc on 04.04.16.
- */
-
-const _ = require('lodash');
-const tool    = '/usr/bin/nmcli';
-const cmdLine = tool + ' -m tabular -f SSID,BSSID,SIGNAL,FREQ device wifi';
-
-const macRegex = /([0-9a-zA-Z]{1}[0-9a-zA-Z]{1}[:]{1}){5}[0-9a-zA-Z]{1}[0-9a-zA-Z]{1}/;
-/**
- * Parsing the output of nmcli
- * @param str output of the tool
- * @param callback
- */
-function parseOutput(str, callback) {
-  var err = null;
-
-  try {
-    var lines      = str.split('\n');
-    var wifis = [];
-
-    for (var i = 1, l = lines.length; i < l; i++) {
-      var mac = lines[i].match(macRegex);
-      if (!mac) {
-        continue;
-      }
-      var macStart = lines[i].indexOf(mac[0]);
-      var elements = lines[i].substr(macStart).split(/[ ]+/);
-      wifis.push({
-        'ssid'    : _.trim(lines[i].substr(0, macStart), ' \''),
-        'mac'     : elements[0].trim(),
-        'channel' : parseInt(elements[2].trim(), 10),
-        'rssi'    : parseInt(elements[1].trim())
-      });
-    }
-  }
-  catch (ex) {
-    err = ex;
-  }
-
-  callback(err, wifis);
-}
-
-
-module.exports = {
-  parseOutput: parseOutput,
-  cmdLine    : cmdLine,
-  tool       : tool
-};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-wifi-scanner",
-  "version": "0.0.5",
+  "version": "1.1.3",
   "description": "node.js module for WiFi network detection",
   "main": "index.js",
   "keywords": [
@@ -35,11 +35,12 @@
     "test": "mocha test"
   },
   "dependencies": {
-    "lodash": "4.8.1"
+    "async": "3.2.4",
+    "lodash": "4.17.21"
   },
   "devDependencies": {
-    "grunt": "0.4.5",
-    "grunt-bump": "0.7.0",
-    "mocha": "2.2.5"
+    "grunt": "1.5.3",
+    "grunt-bump": "0.8.0",
+    "mocha": "10.2.0"
   }
 }

test/airport.js

@@ -16,8 +16,8 @@ describe('airport', () => {
       assert.ok(info);
       assert.equal(info.length, 36);
 
-      var ap = info[0];
-      assert.equal(ap.mac, '00:35:1a:90:56:03');
+      let ap = info[0];
+      assert.equal(ap.mac, '');
       assert.equal(ap.ssid, 'OurTest');
       assert.equal(ap.rssi, -70);
       assert.strictEqual(ap.channel, 112);
@@ -49,7 +49,7 @@ describe('airport', () => {
       assert.ok(info);
       assert.equal(info.length, 4);
 
-      var ap = info[0];
+      let ap = info[0];
       assert.equal(ap.mac, '7c:b7:33:ae:3b:06');
       assert.equal(ap.ssid, 'Raupo');
       assert.equal(ap.rssi, -80);
@@ -64,4 +64,4 @@ describe('airport', () => {
       done(err);
     });
   });
-});
+});

test/fixtures/airport/airport01.txt

@@ -1,5 +1,5 @@
                             SSID BSSID             RSSI CHANNEL HT CC SECURITY (auth/unicast/group)
-                         OurTest 00:35:1a:90:56:03 -70  112     Y  CH WPA2(PSK/AES/AES) 
+                         OurTest                   -70  112     Y  CH WPA2(PSK/AES/AES) 
                           OurDev 00:35:1a:90:56:04 -70  112     Y  CH WPA2(PSK/AES/AES) 
                          PDANet1 00:35:1a:90:56:09 -70  112     Y  CH WPA2(PSK/AES/AES) 
                        TEST-Wifi 00:35:1a:90:56:0f -70  112     Y  CH WPA2(PSK/AES/AES) 

test/fixtures/nmcli/nmcli01.txt

@@ -1,20 +0,0 @@
-SSID                              BSSID               SIGNAL   FREQUENZ  
-'PDANet1'                         00:35:1A:90:56:06   100      2412 MHz  
-'ExoNet1'                         00:35:1A:90:56:05   100      2412 MHz  
-'TEST-Wifi'                       00:35:1A:90:56:00   96       2412 MHz  
-'OurTest'                         00:35:1A:90:56:0C   96       2412 MHz  
-'OurDev'                          00:35:1A:90:56:0B   76       2412 MHz  
-'PDANet1'                         00:35:1A:6F:0F:46   48       2437 MHz  
-'TEST-Wifi'                       00:35:1A:6F:0F:40   58       2437 MHz  
-'ExoNet1'                         00:35:1A:6F:0F:45   58       2437 MHz  
-'OurDev'                          00:35:1A:6F:0F:4B   58       2437 MHz  
-'OurTest'                         00:35:1A:6F:0F:4C   60       2437 MHz  
-'TEST-Wifi'                       00:F2:8B:8F:58:70   58       2462 MHz  
-'ExoNet1'                         00:F2:8B:8F:58:75   72       2462 MHz  
-'PDANet1'                         00:F2:8B:8F:58:76   58       2462 MHz  
-'PDANet1'                         00:35:1A:5B:46:76   56       2412 MHz  
-'OurDev'                          00:35:1A:5B:46:7B   48       2412 MHz  
-'OurDev'                          00:F2:8B:8F:58:7B   58       2462 MHz  
-'OurTest'                         00:F2:8B:8F:58:7C   72       2462 MHz  
-'TEST-Wifi'                       00:35:1A:5B:46:70   56       2412 MHz  
-'OurTest'                         00:35:1A:5B:46:7C   48       2412 MHz  

test/iwlist.js

@@ -22,7 +22,7 @@ describe('iwlist', () => {
 
       assert.ok(info);
 
-      var ap = info[0];
+      let ap = info[0];
       assert.equal(ap.mac, 'D4:D1:84:50:76:45');
       assert.equal(ap.ssid, 'gsy-97796');
       assert.equal(ap.rssi, -76);
@@ -40,7 +40,7 @@ describe('iwlist', () => {
     iwlist.parseOutput(fs.readFileSync(path.join(__dirname, 'fixtures','iwlist','iwlist03_raspi.txt'), { encoding: 'utf8' }), (err, info) => {
       assert.ok(info);
       
-      var ap = info[0];
+      let ap = info[0];
       assert.equal(ap.mac, '00:35:1A:90:56:00');
       assert.equal(ap.ssid, 'LORA-Wifi');
       assert.equal(ap.rssi, -71);
@@ -55,4 +55,4 @@ describe('iwlist', () => {
     });
   });
 
-});
+});

test/netsh.js

@@ -16,7 +16,7 @@ describe('netsh', function () {
       assert.ok(info);
       assert.equal(info.length, 86);
       
-      var ap = info[0];
+      let ap = info[0];
       assert.equal(ap.mac, '00:f2:8b:8c:a6:88');
       assert.equal(ap.ssid, '');
       assert.equal(ap.rssi, -88.5);
@@ -55,7 +55,7 @@ describe('netsh', function () {
       assert.ok(info);
       assert.equal(info.length, 86);
       
-      var ap = info[0];
+      let ap = info[0];
       assert.equal(ap.mac, '00:f2:8b:8c:a6:88');
       assert.equal(ap.ssid, '');
       assert.equal(ap.rssi, -88.5);
@@ -94,7 +94,7 @@ describe('netsh', function () {
       assert.ok(info);
       assert.equal(info.length, 8);
 
-      var ap = info[0];
+      let ap = info[0];
       assert.equal(ap.mac, '98:fc:11:b6:88:9e');
       assert.equal(ap.ssid, 'CARAMANZANAS_BAJA');
       assert.equal(ap.rssi, -86);

test/nmcli.js

@@ -1,30 +0,0 @@
-/**
- * nmcli unit test
- * Created by kc on 04.04.16.
- */
-
-const fs = require('fs');
-const path = require('path');
-const assert = require('assert');
-
-const nmcli = require('../lib/nmcli');
-
-describe.skip('nmcli', () => {
-  it('parses the output of file 1', function(done) {
-    nmcli.parseOutput(fs.readFileSync(path.join(__dirname, 'fixtures','nmcli','nmcli01.txt'), { encoding: 'utf8' }), (err, info) => {
-
-      console.log(info);
-      assert.ok(info);
-      assert.equal(info.length, 19);
-
-      var ap = info[0];
-      assert.equal(ap.mac, '00:35:1A:90:56:06');
-      assert.equal(ap.ssid, 'PDANet1');
-      //assert.equal(ap.rssi, -70);
-      assert.strictEqual(ap.channel, 112);
-
-      done(err);
-    });
-  });
-
-});