Source: org/terraswarm/accessor/accessors/web/services/WiFiScan.js

  1. // Copyright (c) 2017 The Regents of the University of California.
  2. // All rights reserved.
  3. //
  4. // Permission is hereby granted, without written agreement and without
  5. // license or royalty fees, to use, copy, modify, and distribute this
  6. // software and its documentation for any purpose, provided that the above
  7. // copyright notice and the following two paragraphs appear in all copies
  8. // of this software.
  9. //
  10. // IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. // FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
  13. // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
  14. // SUCH DAMAGE.
  15. //
  16. // THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  17. // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18. // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
  19. // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
  20. // CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  21. // ENHANCEMENTS, OR MODIFICATIONS.
  22. //
  24. /** Obtain a scan of nearby WiFi networks. 
  25.  *
  26.  *  The output is in the form below:
  27.  *  ```
  28.  *   networks = [
  29.  *        {   "level": signal_level, // raw RSSI value
  30.  *            "SSID": ssid, // SSID as string, with escaped double quotes: "\"ssid name\""
  31.  *            "BSSID": bssid // MAC address of WiFi router as string
  32.  *            "frequency": frequency of the access point channel in MHz
  33.  *            "capabilities": capabilities // Describes the authentication, key management, and encryption schemes supported by the access point.
  34.  *        }
  35.  *    ]
  36.  *  ```
  37.  *
  38.  *  @accessor services/WiFiScan
  39.  *  @input trigger Initiates a WiFiScan. 
  40.  *  @output wifiData The list of networks obtained from the
  41.  *  wifi-scanner module. The output is a JSON array of objects shown
  42.  *  above.
  43.  *  
  44.  *  @author Matt Weber
  45.  *  @version $$Id: swarmlet.js 1502 2017-04-17 21:34:03Z cxh $$
  46.  */
  48. // Stop extra messages from jslint and jshint.  Note that there should
  49. // be no space between the / and the * and global. See
  50. // https://chess.eecs.berkeley.edu/ptexternal/wiki/Main/JSHint */
  51. /*globals addInputHandler, console, get, getParameter, getResource, error, exports, extend, get, input, output, parameter, require, send */
  52. /*jshint globalstrict: true*/
  53. 'use strict';
  55. var scanner = require('@accessors-modules/wifi-scanner');
  57. exports.setup = function(){
  58.     this.input('trigger');
  59.     this.output('wifiData',{
  60.         'type':'JSON'
  61.     });
  62.  };
  64. //Callback function passed to scanner.scan
  65. function scanSuccess(arg){
  66.     this.send('wifiData', arg);
  67. };
  69. //Callback function passed to scanner.scan
  70. function scanFailure(arg){
  71.     throw "WiFiScan scanning failed: " + JSON.stringify(arg);
  72. };
  74. exports.initialize = function(){
  75.     var thiz = this;
  77.     this.addInputHandler('trigger', function(){
  78.         scanner.scan(scanSuccess.bind(thiz), scanFailure.bind(thiz));
  79.     });
  80.  };