Merge pull request #22 from aj-ptw/development

Development

Author: AJ Keller

.eslintrc

@@ -1 +1,10 @@
-{"extends": ["standard"], "parser": "babel-eslint"}
+{
+  "extends": ["semistandard"],
+  "plugins": [
+    "chai-friendly"
+  ],
+  "rules": {
+    "no-unused-expressions": 0,
+    "chai-friendly/no-unused-expressions": 2
+  }
+}

.gitignore

@@ -52,3 +52,5 @@ jspm_packages
 .idea
 .idea/*.xml
 .DS_Store
+
+dist

changelog.md CHANGELOG.md

@@ -1,47 +1,132 @@
-# 0.1.2
+# v0.3.0
+
+### Breaking Changes
+
+* Removed simulator file back into cyton repo
+* Removed `safe-buffer` in place of `buffer`
+* Removed support for node version 5 and below
+
+# v0.2.7
+
+### Bug Fixes
+
+* No `stopByte` property for daisy samples. Added tests.
+
+# v0.2.6
+
+### Bug Fixes
+
+* Accel data with counts did not work for cyton with daisy over wifi.
+
+# v0.2.5
+
+### Bug Fixes
+
+* Had incorrect ganglion accel multiplication factor of 32mg per count but was really 16mg per count
+* `newSample` and `newSampleNoScale` in utility file did not have `valid` is `true` property.
+
+# v0.2.4
+
+### New Features
+
+* Add new constants for emitter
+
+### Bug Fixes
+
+* Fix bug where ganglion sample channel data when scale was false produced array of 8 values instead of 4
+
+# v0.2.3
+
+### New Features
+
+* Add function for parsing an impedance object `.parsePacketImpedance()`
+
+# v0.2.2
+
+### Bug Fixes
+
+* Fix wrap around bug in extractRawBLEDataPackets
+
+# v0.2.1
+
+### Bug Fixes
+
+* Accel data with counts did not work for cyton with daisy. Also fixed up some test errors with the effected functions.
+
+### New Features
+
+* Add features for `openbci-ganglion`
+
+# v0.2.0
+
+### New Feature
+
+* With scale option false, `.parsePacketStandardAccel()` `.parsePacketTimeSyncedAccel()` will now return array called will now return `accelDataCounts` property with un-scaled data.
+
+# v0.1.5
+
+### Bug Fixes
+
+* Was missing errors in constants used by ganglion and other ble projects.
+* Fixed getChannelData functions to support 2 channel cytons
+
+# v0.1.4
+
+### Bug Fixes
+
+* E-patch on new function added 0.1.3
+
+
+# v0.1.3
+
+### New Features
+
+* A bunch of functions to support synchronization of channel settings with cyton. Will be used by both the Wifi and the Cyton node modules.
+
+# v0.1.2
 
 ### Bug Fixes
 
 * Send counts did not work for daisy.
 * Sample output was inconsistent
 * Fixed `timeStamp` to `timestamp` this was pr #147 (thanks @alexdevmotion)
 
-# 0.1.1
+# v0.1.1
 
 ### Bug Fixes
 
 * Send counts did not work for daisy.
 
-# 0.1.0
+# v0.1.0
 
 ### New Functions
 
-* Add function `getFirmware(dataBuffer)` to utilities 
+* Add function `getFirmware(dataBuffer)` to utilities
 
 ### Breaking Changes
 
 * Removed function called `findV2Firmware()` because it's useless with v3.0.0 firmware
 
-# 0.0.10
+# v0.0.10
 
 ### New Function
 
 * Add `boardTypeForNumberOfChannels()` to Constants
 
-# 0.0.9
+# v0.0.9
 
 ### New Features
 
 * Add impedance calculation functions from cyton
 * The simulator from OpenBCI_NodeJS has been ripped out and place into this library! Woo.
 
-# 0.0.8
+# v0.0.8
 
 ### New Features
 
 * Sample object now has property `valid` of type `boolean`, `false` when error parseing packet, `true` otherwise. On `false` there will be another property called `error` of type `string` which contains an error message.
 
-# 0.0.7
+# v0.0.7
 
 ### Continuous Integration
 
@@ -54,9 +139,9 @@
 ### New Features
 
 * In openBCIUtilities.js add function `transformRawDataPacketToSample` to parse a single raw data packet
-* In openBCIConstants.js add function `rawDataToSampleObjectDefault(numChannels)` which should be used by drivers to create the object that is passed through each call to `transformRawDataPacketsToSample` 
+* In openBCIConstants.js add function `rawDataToSampleObjectDefault(numChannels)` which should be used by drivers to create the object that is passed through each call to `transformRawDataPacketsToSample`
 
-# 0.0.6
+# v0.0.6
 
 ### Bug Fixes
 
@@ -72,19 +157,19 @@
 
 * `getChannelDataArray` now takes object as only arg.
 
-# 0.0.5
+# v0.0.5
 
 ### Bug Fixes
 
 * When not scaling outputs `channelDataCounts` instead of `channelData`
 
-# 0.0.4
+# v0.0.4
 
 ### Bug Fixes
 
 * Fix bug where samples were not properly being extracted
 
-# 0.0.2
+# v0.0.2
 
 ### Breaking Changes
 
@@ -96,6 +181,6 @@
 
 * Added a function in the sample module that parses a raw buffer of OpenBCI data, extracts raw data packets and returns the buffer with just the raw data packets removed. Allowing the user to process other data that is not a raw data.
 
-# 0.0.1
+# v0.0.1
 
 Initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# OpenBCI JavaScript Utilities Library Code of Conduct
+
+## Purpose
+
+It is our hope that any one is able to contribute to OpenBCI JavaScript Utilities Library 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?
+
+This is currently a small, humble project so our contribution process is rather casual. Take a look at our [GitHub Projects board to see](https://github.com/NeuroTechX/eeg-101/projects) to see all the features we are currently working on. If there's a feature you'd be interested in building, go ahead! Let us know on the #interactive-tutorial channel on [the NeuroTechX Slack](http://neurotechx.herokuapp.com/) 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)