New version added v1.1.0

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+branches:
+  only:
+    - master
+    - develop
+node_js:
+   - "4"
+   - "5"

README.md

@@ -1,5 +1,9 @@
 #node-wifi-scanner
 
+[![Build Status](https://travis-ci.org/ancasicolica/node-wifi-scanner.svg?branch=master)](https://travis-ci.org/ancasicolica/node-wifi-scanner)
+[![npm](https://img.shields.io/npm/v/node-wifi-scanner.svg)]()
+[![npm](https://img.shields.io/npm/dt/node-wifi-scanner.svg)](https://www.npmjs.com/package/node-wifi-scanner)
+
 This module for node.js scans available wifi networks. The main purpose was to enhance my node.js based
 [ZigBee Site Survey Tool](http://ancasicolica.github.io/ZigBeeSiteSurvey/) with WiFi coexistence charts. This tool
 claims to be compatible with current versions of Mac OS-X, Windows and Linux so I'll fix bugs as fast as possible.
@@ -9,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:
@@ -19,6 +21,10 @@ It was tested with the following operating systems:
 * Ubuntu 14.04
 * Raspbian "Jessie"
 
+## Installation
+
+    npm i node-wifi-scanner
+
 ## Usage
 
     const scanner = require('node-wifi-scanner');
@@ -48,7 +54,6 @@ 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`
 
 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
@@ -77,3 +82,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+

index.js

@@ -5,43 +5,61 @@
 
 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;
 
 // 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) {
+  // When a command is not found, an error is issued and async would finish. Therefore we pack
-      if (stats) {
+  // the error into the result and check it later on.
-        return callback(null, iwlist);
+  async.parallel([
-      }
+      function (cb) {
-
+        exec(airport.detector, function (err) {
-      fs.stat(nmcli.tool, function (err, stats) {
+            cb(null, {err: err, scanner: airport}
-        if (stats) {
+            )
-          return callback(null, nmcli);
-        }
-
-        fs.stat(netsh.tool, function (err, stats) {
-          if (stats) {
-            return callback(null, netsh);
           }
-
+        );
-          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) {
+      var 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 +77,7 @@ module.exports = {
    */
   scan: function (callback) {
     if (!scanner) {
-      initTools((err, s) => {
+      initTools(function (err, s) {
         if (err) {
           return callback(err);
         }

lib/airport.js

@@ -5,6 +5,7 @@
 
 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}/;
 /**
@@ -30,7 +31,7 @@ function parseOutput(str, callback) {
         'ssid'    : lines[i].substr(0, macStart).trim(),
         'mac'     : elements[0].trim(),
         'channel' : parseInt(elements[2].trim(), 10),
-        'rssi'    : parseInt(elements[1].trim())
+        'rssi'    : parseInt(elements[1].trim(), 10)
       });
     }
   }
@@ -45,5 +46,6 @@ function parseOutput(str, callback) {
 module.exports = {
   parseOutput: parseOutput,
   cmdLine    : cmdLine,
+  detector   : detector,
   tool       : tool
 };

lib/iwlist.js

@@ -4,8 +4,12 @@
  */
 
 const _       = require('lodash');
-const tool    = '/usr/bin/iwlist';
+// 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:/;
@@ -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
@@ -18,9 +19,13 @@ function parseOutput(str, callback) {
   var wifis  = [];
   var err    = null;
   try {
+    if (blocks.length < 2) {
+      // 2nd try, with \r\n
+      blocks = str.split('\r\n\r\n')
+    }
     if (!blocks || blocks.length === 1) {
       // No WiFis found
-      return [];
+      return callback(null, []);
     }
 
     // Each block has the same structure, while some parts might be available and others
@@ -67,7 +72,7 @@ function parseOutput(str, callback) {
           // 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);
           }
         }
       }
@@ -86,5 +91,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,36 +1,46 @@
 {
   "name": "node-wifi-scanner",
-  "version": "0.0.3",
+  "version": "1.1.0",
   "description": "node.js module for WiFi network detection",
   "main": "index.js",
   "keywords": [
     "WiFi",
     "Node.js",
-    "scanner"
+    "scanner",
+    "airport",
+    "netsh",
+    "iwlist",
+    "nmcli"
   ],
   "author": {
     "name": "Christian Kuster, CH-8342 Wernetshausen",
     "email": "info@kusti.ch",
     "url": "http://www.kusti.ch/"
   },
-  "homepage": "http://www.ferropoly.ch/",
+  "homepage": "https://github.com/ancasicolica/node-wifi-scanner",
+  "bugs": {
+    "url": "https://github.com/ancasicolica/node-wifi-scanner/issues",
+    "email": "info@ancasicolica.ch"
+  },
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/ancasicolica/node-wifi-scanner.git"
   },
   "engines": {
-    "node": ">= 4.4.0",
+    "node": ">= 4.0.0",
-    "npm": ">= 2.14.0"
+    "npm": ">= 2.0.0"
   },
   "scripts": {
     "test": "mocha test"
   },
   "dependencies": {
-    "lodash": "4.8.1"
+    "async": "2.1.4",
+    "lodash": "4.17.2"
   },
   "devDependencies": {
     "grunt": "0.4.5",
-    "grunt-bump": "0.7.0"
+    "grunt-bump": "0.7.0",
+    "mocha": "2.2.5"
   }
 }

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/netsh.js

@@ -93,7 +93,7 @@ describe('netsh', function () {
     netsh.parseOutput(fs.readFileSync(path.join(__dirname, 'fixtures', 'netsh', 'netsh_sp.txt'), {encoding: 'utf8'}), (err, info) => {
       assert.ok(info);
       assert.equal(info.length, 8);
-      console.log(info);
+
       var ap = info[0];
       assert.equal(ap.mac, '98:fc:11:b6:88:9e');
       assert.equal(ap.ssid, 'CARAMANZANAS_BAJA');

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);
-    });
-  });
-
-});