Merge pull request #24 from daniellasry/master

DOCS: Update to v1.0.0 and rename package to @openbci/wifi

# v1.0.0

### Breaking Changes

Name of package is now @openbci/wifi

### Enhancements

Include node 10 in testing

Author: daniellasry

.travis.yml

@@ -2,6 +2,7 @@ language: node_js
 node_js:
   - "6.11"
   - "8.5"
+  - "10"
 install:
   - npm install --all
 script:

CHANGELOG.md

@@ -1,3 +1,13 @@
+# v1.0.0
+
+### Breaking Changes
+
+Name of package is now @openbci/wifi
+
+### Enhancements
+
+Include node 10 in testing
+
 # v0.4.2
 
 ### Examples

README.md

@@ -9,7 +9,7 @@
 
 [![codecov](https://codecov.io/gh/OpenBCI/OpenBCI_NodeJS_Wifi/branch/master/graph/badge.svg)](https://codecov.io/gh/OpenBCI/OpenBCI_NodeJS_Wifi)
 [![Dependency Status](https://david-dm.org/OpenBCI/OpenBCI_NodeJS_Wifi.svg)](https://david-dm.org/OpenBCI/OpenBCI_NodeJS_Wifi)
-[![npm](https://img.shields.io/npm/dm/openbci-wifi.svg?maxAge=2592000)](http://npmjs.com/package/openbci-wifi)
+[![npm](https://img.shields.io/npm/dm/@openbci/wifi.svg?maxAge=2592000)](http://npmjs.com/package/@openbci/wifi)
 [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)
 
 ## Welcome!
@@ -133,14 +133,14 @@ We assume you have NodeJS installed already, if you don't please [download the l
 Then simply using the node package manager command line tool, enter:
 
 ```
-npm install openbci-wifi
+npm install @openbci/wifi
 ```
 
 ## <a name="tldr"></a> TL;DR:
 Get connected and [start streaming right now with the example code](examples/getStreaming/getStreaming.js).
 
 ```ecmascript 6
-const Wifi = require('openbci-wifi');
+const Wifi = require('@openbci/wifi');
 let wifi = new Wifi({
   debug: false,
   verbose: true,
@@ -202,31 +202,31 @@ Initialization
 Initializing the board:
 
 ```js
-const Wifi = require('openbci-wifi');
+const Wifi = require('../../openBCIWifi');
 const ourBoard = new Wifi();
 ```
 Go [checkout out the get streaming example](examples/getStreaming/getStreaming.js)!
 
 For initializing with options, such as verbose print outs:
 
 ```js
-const Wifi = require('openbci-wifi');
+const Wifi = require('../../openBCIWifi');
 const wifi = new Wifi({
   verbose: true
 });
 ```
 
 or if you are using ES6:
 ```js
-import Wifi from 'openbci-wifi';
-import { Constants } from 'openbci-utilities';
+import Wifi from '../../openBCIWifi';
+import { constants } from '@openbci/utilities';
 const wifi = new Wifi();
 wifi.connect("OpenBCI-2114");
 ```
 
 To debug, it's amazing, do:
 ```js
-const Wifi = require('openbci-wifi');
+const Wifi = require('../../openBCIWifi');
 const wifi = new Wifi({
     debug: true
 });
@@ -252,7 +252,7 @@ To get a 'sample' event, you need to:
 1. Install the 'sample' event emitter
 2. Call [`.searchToStream(_options_)`](#Wifi-connect)
 ```js
-const Wifi = require('openbci-wifi');
+const Wifi = require('../../openBCIWifi');
 let wifi = new Wifi({
   debug: false,
   verbose: true,
@@ -278,7 +278,7 @@ wifi.searchToStream({
 ```
 Close the connection with [`.streamStop()`](#Wifi+streamStop) and disconnect with [`.disconnect()`](#Wifi+disconnect)
 ```js
-const Wifi = require('openbci-wifi');
+const Wifi = require('../../openBCIWifi');
 const wifi = new Wifi();
 wifi.streamStop().then(wifi.disconnect());
 ```

examples/getStreaming/getStreaming.js

@@ -1,4 +1,4 @@
-/*jslint es6*/
+/* jslint es6 */
 /**
  * This is an example from the readme.md
  * On windows you should run with PowerShell not git bash.
@@ -10,16 +10,16 @@
  *   do `npm install`
  *   then `npm start`
  */
-"use strict";
-const OBCIConsts = require("openbci-utilities").Constants;
-const OBCIWifi = require("../../openBCIWifi");
+'use strict';
+const OBCIConsts = require('@openbci/utilities').constants;
+const OBCIWifi = require('../../openBCIWifi');
 
 const wifi = new OBCIWifi({
-  debug: false,               // Pretty print bytes
-  verbose: true,              // Verbose output
+  debug: false, // Pretty print bytes
+  verbose: true, // Verbose output
   sendCounts: false,
   latency: 16667,
-  protocol: "tcp"             // or "udp"
+  protocol: 'tcp' // or "udp"
 });
 
 let counter = 0;
@@ -49,7 +49,7 @@ const sampleFunc = (sample) => {
           console.log(`Dropped ${droppedPackets} packets`);
           console.log(`Dropped packet average: ${dpSum / droppedPacketArray.length}`);
           console.log(`Sample rate average: ${srSum / sampleRateArray.length}`);
-          
+
           droppedPackets = 0;
           counter = 0;
         }, 1000);
@@ -63,7 +63,7 @@ const sampleFunc = (sample) => {
         console.log(`dropped ${packetDiff} packets | cur sn: ${sample.sampleNumber} | last sn: ${lastSampleNumber}`);
         droppedPackets += packetDiff;
       }
-      
+
       lastSampleNumber = sample.sampleNumber;
       // console.log(JSON.stringify(sample));
     }
@@ -80,9 +80,9 @@ wifi.on(OBCIConsts.OBCIEmitterSample, sampleFunc);
 // wifi.on(OBCIConsts.OBCIEmitterRawDataPacket, console.log);
 
 wifi.searchToStream({
-    streamStart: true,
-    sampleRate: 200
-  })
+  streamStart: true,
+  sampleRate: 200
+})
   .then(() => {
     MAX_SAMPLE_NUMBER = wifi.getNumberOfChannels() === 4 ? 200 : 255;
   })
@@ -93,31 +93,31 @@ wifi.searchToStream({
 
 function exitHandler (options, err) {
   if (options.cleanup) {
-    if (options.verbose) console.log("clean");
+    if (options.verbose) console.log('clean');
     /** Do additional clean up here */
     if (wifi.isConnected()) wifi.disconnect().catch(console.log);
-    
-    wifi.removeAllListeners("rawDataPacket");
-    wifi.removeAllListeners("sample");
+
+    wifi.removeAllListeners('rawDataPacket');
+    wifi.removeAllListeners('sample');
     wifi.destroy();
 
     if (sampleRateCounterInterval) clearInterval(sampleRateCounterInterval);
   }
-  
+
   if (err) console.error(err.stack);
-  
+
   if (options.exit) {
-    if (options.verbose) console.log("exit");
+    if (options.verbose) console.log('exit');
 
     if (wifi.isStreaming()) {
       const _t = setTimeout(() => {
-        console.log("timeout");
+        console.log('timeout');
         process.exit(0);
       }, 1000);
 
       wifi.streamStop()
         .then(() => {
-          console.log("stream stopped");
+          console.log('stream stopped');
           if (_t) clearTimeout(_t);
           process.exit(0);
         }).catch((err) => {
@@ -130,28 +130,28 @@ function exitHandler (options, err) {
   }
 }
 
-if (process.platform === "win32") {
-  const rl = require("readline").createInterface({
+if (process.platform === 'win32') {
+  const rl = require('readline').createInterface({
     input: process.stdin,
     output: process.stdout
   });
 
-  rl.on("SIGINT", function () {
-    process.emit("SIGINT");
+  rl.on('SIGINT', function () {
+    process.emit('SIGINT');
   });
 }
 
 // Perform actions on exit
-process.on("exit", exitHandler.bind(null, {
+process.on('exit', exitHandler.bind(null, {
   cleanup: true
 }));
 
 // Perform actions on SIGINT
-process.on("SIGINT", exitHandler.bind(null, {
+process.on('SIGINT', exitHandler.bind(null, {
   exit: true
 }));
 
 // Perform actions on uncaught exceptions
-process.on("uncaughtException", exitHandler.bind(null, {
+process.on('uncaughtException', exitHandler.bind(null, {
   exit: true
 }));

examples/getStreamingWiFiDirect/getStreamingWiFiDirect.js

@@ -1,4 +1,4 @@
-/*jslint es6*/
+/* jslint es6 */
 /**
  * This is an example from the readme.md
  * On windows you should run with PowerShell not git bash.
@@ -10,18 +10,18 @@
  *   do `npm install`
  *   then `npm start`
  */
-"use strict";
-const OpenBCIConsts = require("openbci-utilities").Constants;
-const OpenBCIWifi = require("../../openBCIWifi");
+'use strict';
+const OpenBCIConsts = require('@openbci/utilities').constants;
+const OpenBCIWifi = require('../../openBCIWifi');
 
-const deviceAddr = "10.0.1.3";
+const deviceAddr = '10.0.1.3';
 
 const wifi = new OpenBCIWifi({
-  debug: false,                   // Pretty print bytes
-  verbose: false,                 // Verbose output
+  debug: false, // Pretty print bytes
+  verbose: false, // Verbose output
   sendCounts: false,
   latency: 16667,
-  protocol: "tcp",                // or "udp"
+  protocol: 'tcp', // or "udp"
   burst: true
 });
 
@@ -45,7 +45,6 @@ const sampleFunc = (sample) => {
           droppedPacketArray.push(droppedPackets);
           sampleRateArray.push(counter);
 
-
           const dpSum = droppedPacketArray.reduce(sum, 0);
           const srSum = sampleRateArray.reduce(sum, 0);
 
@@ -56,7 +55,6 @@ const sampleFunc = (sample) => {
 
           droppedPackets = 0;
           counter = 0;
-
         }, 1000);
       }
 
@@ -85,10 +83,10 @@ wifi.on(OpenBCIConsts.OBCIEmitterSample, sampleFunc);
 // wifi.on(OpenBCIConsts.OBCIEmitterRawDataPacket, console.log);
 
 wifi.connect({
-    sampleRate: 200,
-    streamStart: true,
-    ipAddress: deviceAddr
-  })
+  sampleRate: 200,
+  streamStart: true,
+  ipAddress: deviceAddr
+})
   .then(() => {
     MAX_SAMPLE_NUMBER = wifi.getNumberOfChannels() === 4 ? 200 : 255;
   })
@@ -99,31 +97,31 @@ wifi.connect({
 
 function exitHandler (options, err) {
   if (options.cleanup) {
-    if (options.verbose) console.log("clean");
+    if (options.verbose) console.log('clean');
     /** Do additional clean up here */
     if (wifi.isConnected()) wifi.disconnect().catch(console.log);
 
-    wifi.removeAllListeners("rawDataPacket");
-    wifi.removeAllListeners("sample");
+    wifi.removeAllListeners('rawDataPacket');
+    wifi.removeAllListeners('sample');
     wifi.destroy();
-    
+
     if (sampleRateCounterInterval) clearInterval(sampleRateCounterInterval);
   }
 
   if (err) console.log(err.stack);
-  
+
   if (options.exit) {
-    if (options.verbose) console.log("exit");
+    if (options.verbose) console.log('exit');
 
     if (wifi.isStreaming()) {
       const _t = setTimeout(() => {
-        console.log("timeout");
+        console.log('timeout');
         process.exit(0);
       }, 1000);
 
       wifi.streamStop()
         .then(() => {
-          console.log("stream stopped");
+          console.log('stream stopped');
           if (_t) clearTimeout(_t);
           process.exit(0);
         }).catch((err) => {
@@ -136,28 +134,28 @@ function exitHandler (options, err) {
   }
 }
 
-if (process.platform === "win32") {
-  const rl = require("readline").createInterface({
+if (process.platform === 'win32') {
+  const rl = require('readline').createInterface({
     input: process.stdin,
     output: process.stdout
   });
 
-  rl.on("SIGINT", function () {
-    process.emit("SIGINT");
+  rl.on('SIGINT', function () {
+    process.emit('SIGINT');
   });
 }
 
 // do something when app is closing
-process.on("exit", exitHandler.bind(null, {
+process.on('exit', exitHandler.bind(null, {
   cleanup: true
 }));
 
 // catches ctrl+c event
-process.on("SIGINT", exitHandler.bind(null, {
+process.on('SIGINT', exitHandler.bind(null, {
   exit: true
 }));
 
 // catches uncaught exceptions
-process.on("uncaughtException", exitHandler.bind(null, {
+process.on('uncaughtException', exitHandler.bind(null, {
   exit: true
-}));
+}));