1.4.0

[andrewjaykeller]

1.4.0

New Features

• Three new initialization options: simulatorFragmentation, simulatorBufferSize, and simulatorLatencyTimer. Together, these enable a more realistic serial port simulation, mimicking different potential user computer systems.
• New option debug gives a live dump of serial traffic on the console if enabled
• New API function .isConnected() to check if communications are active.
• New API function .isStreaming() to check if samples are coming from the board.

Enhancements

• Implement and adapt semi-standard code style. Closes #83
• autoFindOpenBCIBoard now notices and uses the stock dongle on Linux
• 'synced' object now has error property, null on good syncs, error description on bad syncs.

Breaking Changes

• The setting for simulatorInjectLineNoise has changed from None to none
• connect() will now fail if already connected
• The constructor will throw an error now if an invalid option is passed
• The .connected property has been removed, replaced by .isConnected(). Removed from docs.
• The .streaming property has been removed, replaced by .isStreaming(). Removed from docs.
• An error event will be emitted if sntp fails to initialize on construction
• The simulator will no longer communicate when disconnected

Bug Fixes

• Fixed bug where early packet fragments were dropped after board reset
• Fixed bug where time sync replies that began a buffered chunk were ignored
• Fixed bug where simulator would output wrong version in its reset message
• Fixed bug where resources were not cleaned up if connect was called twice
• Fixed bug where serial data was written after disconnection
• Fixed bug where unexpected disconnection was not detected
• Fixed bug where promises could lead to out of order packet processing.

[andrewjaykeller]

@baffo32 let's move the convo over when possible. I created a mile stone for 1.4.0 and added the semi standard and your connect without resetting.

[codecov-io]

Current coverage is 94.43% (diff: 95.64%)

Merging #96 into master will increase coverage by 1.63%

@@             master        #96   diff @@
==========================================
  Files             4          4          
  Lines          2193       2263    +70   
  Methods         128        135     +7   
  Messages          0          0          
  Branches        478        484     +6   
==========================================
+ Hits           2035       2137   +102   
+ Misses          158        126    -32   
  Partials          0          0          

Powered by Codecov. Last update d633525...c4e29bb