Merge pull request #161 from aj-ptw/3.0.0

3.0.0

.travis.yml

@@ -1,24 +1,19 @@
 language: node_js
 node_js:
-  - "4.0"
-  - "4.1"
-  - "4.2"
-  - "4.3"
-  - "4.4"
-  - "4.5"
-  - "4.6"
-  - "5.11.0"
-  - "6.0"
-  - "6.1"
-  - "6.2"
-  - "6.3"
-  - "6.4"
-  - "6.5"
-  - "6.6"
-  - "6.7"
-  - "6.8"
+  - "4.8.4"
+  - "6.11.1"
+  - "7.10.1"
+  - "8.1.4"
+env:
+  - CXX=g++-4.8
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8
 install:
   - npm install --all
 script:
-  - npm run lint
-  - npm run test-cov
+  - npm run test-lint
+  - npm run test-cov

changelog.md → CHANGELOG.md

@@ -1,3 +1,110 @@
+# 3.0.0
+
+This adds ganglion, wifi, and cyton support to the `openbci` main library. 
+
+If you only need cyton over serial and so not want the additional support, please see [`openbci-cyton`](https://www.npmjs.com/package/openbci-cyton).
+
+# 2.2.1
+
+### Enhancements
+
+* Bumped openbci-utilities to v0.2.0 for new accel data support
+
+# 2.2.0
+
+### Bug Fixes
+
+* Calling sdStart and stop would change the writeOutDelay
+* Timeout for v1 was set to 10 ms instead of 50 ms.
+* Timeout for v2+ was set to 0 ms instead of 10 ms.
+
+# 2.1.4
+
+### Enhancements
+
+* syncRegisterSettings now resolves channel setting object
+* Bumped openbci-utilities to v0.1.5
+
+# 2.1.3
+
+### Enhancements
+
+* Can now sync the channel settings from the actual registers on the ADS! Call `.syncRegisterSettings()`
+* Bumped openbci-utilities to v0.1.4
+
+# 2.1.2
+
+### Enhancements
+
+* Update openbci-utilities to v0.1.2 to patch for sendCounts.
+* Disconnect did not disconnect from serial port if the device was not streaming.
+
+# 2.1.1
+
+### Bug Fixes
+
+* Closes forgot parentheses in `getBoardType()` #152 (thanks @nateGeorge)
+
+### Enhancements
+
+* Add support for v3 cyton firmware.
+
+# 2.1.0
+
+### Breaking changes
+
+* Significantly reduce the properties in `this.info` object to only have firmware version and number of missed packets. Code dependent on this.info should switch to using `numberOfChannels()`, and `getBoardType()` and `sampleRate()` for accurate board info!
+
+### Enhancements
+
+* Fixes for daisy with new board, specifically hardSet.
+
+# 2.0.1
+
+### Bug Fixes
+
+* Debug bytes was set to always print in processBytes
+
+# 2.0.0
+
+### New Features
+* `index.js` file allows for ES6 destructing
+
+### Breaking Changes
+* Change name of `OpenBCIBoard` to `Cyton` to follow new naming convention.
+    Simply change:
+    ```ecmascript 6
+    const OpenBCIBoard = require('openbci').OpenBCIBoard;
+    const ourBoard = new OpenBCIBoard();
+    ```
+    ```ecmascript 6
+    const Cyton = require('openbci').Cyton;
+    const ourBoard = new Cyton();
+    ```
+* Major change to how board is initialized with removal of `factory` paradigm.
+* New dependency called `openbci-utilities`.
+* Rejections are errors with messages, so check err.message for info on message, don't expect string.
+
+### Bug Fixes
+* Documentation error with `testSignal` function.
+ 
+### Enhancements
+* Add more tests for public API functions.
+
+# 1.5.2
+
+### Dependency Package Updates
+* `performance-now`: from `^0.2.0` to `2.1.0`
+* `serialport` - from `4.0.1` to `4.0.7`
+
+### Development Dependency Package Updates
+* `bluebird`: from `3.4.6` to `3.5.0`
+* `chai-as-promised`: from `^5.2.0` to `^6.0.0`
+* `codecov`: from `^1.0.1` to `^2.1.0`
+* `semistandard`: from `^9.0.0` to `^10.0.0`
+* `sinon`: from `^1.17.2` to `^2.1.0`
+* `snazzy`: from `^5.0.0` to `^6.0.0`
+
 # 1.5.1
 
 ### New Features
@@ -52,7 +159,7 @@
 
 ### Bug Fixes
 * Fixes bug where extra data after EOT (`$$$`) was dumped by preserving the poriton after the EOT for further decomposition.
-* Fixes bug where any calls to channel set would actually break the openBCISample code as the channelSettingsArray contained an undefined.
+* Fixes bug where any calls to channel set would actually break the openBCIUtilities code as the channelSettingsArray contained an undefined.
 * Writes promises resolve when they are actually sent over the serial port. 
 
 # 1.4.0
@@ -198,7 +305,7 @@ The second major release for the OpenBCI Node.js SDK brings major changes, impro
 
 * NPM package is not called `openbci-sdk` anymore, now called `openbci`
 * Accelerometer data now goes into `.accelData` array instead of `.auxData` array.
-* In openBCISample.js
+* In openBCIUtilities.js
   * `parseRawPacket()` is now called `parseRawPacketStandard()`
 * `ready` event only triggered after soft reset. `eot` event emitted in all other conditions resulting in the board sending EOT ("$$$")
 * Must use camel case on the OpenBCISimulator object.
@@ -276,7 +383,7 @@ The second major release for the OpenBCI Node.js SDK brings major changes, impro
 ### Bug Fixes
 
 * updates to README.me and comments to change ntp to sntp, because the two are similar, but not the same and we do not want to be misleading
-* Extended [Stnp](https://www.npmjs.com/package/sntp) to main openBCIBoard.js
+* Extended [Stnp](https://www.npmjs.com/package/sntp) to main openBCICyton.js
 * Add `.sntpNow()` function to get ntp time.
 
 # 0.3.1

CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# OpenBCI NodeJS Code of Conduct
+
+## Purpose
+
+It is our hope that any one is able to contribute to OpenBCI NodeJS regardless of their background. Thus, we hope to provide a safe, welcoming, and warmly geeky environment for everybody, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]](mailto:[email protected]). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+:tada::clinking_glasses:  First off, thanks for taking the time to contribute! :tada::clinking_glasses:
+
+Contributions are always welcome, no matter how small.
+
+The following is a small set of guidelines for how to contribute to the project
+
+## Where to start
+
+### Code of Conduct
+This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md).
+By participating you are expected to adhere to these expectations. Please report unacceptable behaviour to [[email protected]](mailto:[email protected])
+
+### Contributing on Github
+
+If you're new to Git and want to learn how to fork this repo, make your own additions, and include those additions in the master version of this project, check out this [great tutorial](http://blog.davidecoppola.com/2016/11/howto-contribute-to-open-source-project-on-github/).
+
+### Community
+
+This project is maintained by the [OpenBCI](www.openbci.com) and [NeuroTechX](www.neurotechx.com) community. Join the NeuroTechX Slack to check out our #devices channel, where discussions about OpenBCI takes place.
+
+## How can I contribute?
+
+If there's a feature you'd be interested in building, go ahead and we'll support you as much as we can. When you're finished submit a pull request to the master branch referencing the specific issue you addressed.
+
+If you find a bug, or have a suggestion on how to improve the project, just fill out a [Github issue](../../issues)