mindwave 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed135effe8b24459659189d4df0d3b2445f963c7
-  data.tar.gz: 0500dabb9c8eb05846eaf93a1bcfa41605693482
+  metadata.gz: 3749b5d8725c89d97767c7e754aa85925bac04be
+  data.tar.gz: 0a386a4d2adb90b2bc3e140a5f25d0f26f8fd579
 SHA512:
-  metadata.gz: f3f5e8e71535f0de47801a8e35ccf6f273b65ca9fba1408dc009ec851ea4b113c9921006f856542b4fc735388fc4daf7bc9d351ab1c624cc27f7af3b28dce41c
-  data.tar.gz: c12926c28879d754ae458ed29fe98776bffcba1374c93c20307ea10b7c2f9242f6c1fa4ae13c0098498b96fada0435538a613c6850c5fc2e000809cc29c1c59d
+  metadata.gz: ae1104d21949242e4a843ea29db60a8331f41084ab65c016c155c3f34b87234d89db6cca8bdd7635ab59c9cdddf20f400e1f3dffdb37f72684f73ec574cf2a8e
+  data.tar.gz: 25b4a5d9cf33b14f05045bf55f71db5cd5e59f564815e59ff5bfa3680233da4a0ab5d83cbf4c5fcc9404cf1cf7c17f06bbf5957cd2b3b52a4ee7a3490b7601b2

data/README.md

@@ -4,11 +4,10 @@
 [![Build Status](https://travis-ci.org/whotwagner/mindwave.svg?branch=master)](https://travis-ci.org/whotwagner/mindwave)
 [![Inline docs](http://inch-ci.org/github/whotwagner/mindwave.svg?branch=master)](http://inch-ci.org/github/whotwagner/mindwave)
 [![Code Climate](https://codeclimate.com/github/whotwagner/mindwave/badges/gpa.svg)](https://codeclimate.com/github/whotwagner/mindwave)
+[![Gem Version](https://badge.fury.io/rb/mindwave.svg)](https://badge.fury.io/rb/mindwave)
 
 
-This gem is a library for the Neurosky Mindwave headset. It reads out EEG-data from the ThinkGear Serial Stream and provides callback-methods for processing the data.
-
-Even if this library is written for the Mindwave-Headset most of the code should work with the Mindwave-Mobile-Headset too. The big difference is that the methods "connect and disconnect" are not needed for Mindwave Mobile Headsets. 
+This gem is a library for Neurosky Mindwave headsets. It reads out EEG-data from the ThinkGear Serial Stream and provides callback-methods for processing the data. this library works for Mindwave and Mindwave-Mobile.
 
 ## Installation
 
@@ -90,6 +89,52 @@ thread = Thread.new { mw.run }
 # ..and run it
 thread.join
 
+mw.close
+```
+
+Callback for EEG-powers:
+```ruby
+#!/usr/bin/env ruby
+
+require 'mindwave'
+
+class EEG < Mindwave::Headset
+  # override Attention-Callback-Method
+  def asicCall(asic)
+
+    puts "DEBUG: ASIC array: #{asic}\n"
+
+    # pass asic to parseASIC and store result
+    parsed = parseASIC(asic)
+
+    # print the values of the waves to STDOUT
+    puts "delta:     #{parsed[0]}"
+    puts "theta:     #{parsed[1]}"
+    puts "lowAlpha:  #{parsed[2]}"
+    puts "highAlpha: #{parsed[3]}"
+    puts "lowBeta:   #{parsed[4]}"
+    puts "highBeta:  #{parsed[5]}"
+    puts "lowGamma:  #{parsed[6]}"
+    puts "midGamma:  #{parsed[7]}"
+  end
+
+end
+
+# create a new instance
+mw = EEG.new
+# mw.log.level = Logger::DEBUG
+
+# if we hit ctrl+c then just stop the run()-method
+Signal.trap("INT") do
+	mw.stop
+end
+
+# Create a new Thread
+thread = Thread.new { mw.run }
+# ..and run it
+thread.join
+
+
 mw.close
 ```
 
@@ -107,8 +152,6 @@ mw.close
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/whotwagner/mindwave. I am highly interested at pull requests for the mindwave-mobile-headset.

data/examples/asicwaves.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'mindwave'
+
+class EEG < Mindwave::Headset
+  # override Attention-Callback-Method
+  def asicCall(asic)
+
+    puts "DEBUG: ASIC array: #{asic}\n"
+
+    # pass asic to parseASIC and store result
+    parsed = parseASIC(asic)
+
+    # print the values of the waves to STDOUT
+    puts "delta:     #{parsed[0]}"
+    puts "theta:     #{parsed[1]}"
+    puts "lowAlpha:  #{parsed[2]}"
+    puts "highAlpha: #{parsed[3]}"
+    puts "lowBeta:   #{parsed[4]}"
+    puts "highBeta:  #{parsed[5]}"
+    puts "lowGamma:  #{parsed[6]}"
+    puts "midGamma:  #{parsed[7]}"
+  end
+
+end
+
+# create a new instance
+mw = EEG.new
+# mw.log.level = Logger::DEBUG
+
+# if we hit ctrl+c then just stop the run()-method
+Signal.trap("INT") do
+	mw.stop
+end
+
+# Create a new Thread
+thread = Thread.new { mw.run }
+# ..and run it
+thread.join
+
+
+mw.close

data/lib/mindwave.rb

@@ -126,7 +126,7 @@ attr_accessor :headsetid, :device, :rate, :log
 #   stores the current heart-value
 # @!attribute [r] runner
 #   @see #stop
-attr_reader :attention, :meditation, :asic,:poor, :headsetstatus, :heart, :runner
+attr_reader :attention, :meditation, :asic, :poor, :headsetstatus, :heart, :runner
 
 # If connectserial is true, then this constructor opens a serial connection 
 # and automatically connects to the headset
@@ -376,6 +376,37 @@ def parse_payload(payload)
 
 end
 
+# this method parses the raw ASIC values and returns the values of each
+# of the wave types
+#
+# @param [Integer] asic value 
+#
+# @returns [Array<Integer>] Array of: delta,theta,lowAlpha,highAlpha,lowBeta,highBeta,lowGamma,midGamma
+def parseASIC(asic)
+    # assign #{asic} to the array 'a'
+    a = "#{asic}"
+    # strip off square brackets
+    a = a.delete! '[]'
+    # convert to array of integers
+    a = a.split(",").map(&:to_i)
+
+    # define wave values
+    delta     = convertToBigEndianInteger(a[0..3])
+    theta     = convertToBigEndianInteger(a[3..6])
+    lowAlpha  = convertToBigEndianInteger(a[6..9])
+    highAlpha = convertToBigEndianInteger(a[9..12])
+    lowBeta   = convertToBigEndianInteger(a[12..15])
+    highBeta  = convertToBigEndianInteger(a[15..18])
+    lowGamma  = convertToBigEndianInteger(a[18..21])
+    midGamma  = convertToBigEndianInteger(a[21..24])
+
+    # stuff wave values in array
+    asicArray = [delta,theta,lowAlpha,highAlpha,lowBeta,highBeta,lowGamma,midGamma]
+    
+    # return array of wave values
+    return asicArray
+end
+
 # this method sends a byte to the serial connection
 # (Mindwave only)
 #
@@ -526,6 +557,7 @@ end
 #
 # @return [Integer] single value generated from the 2 bytes
 def convertRaw(rawval1,rawval2)
+
 	raw = rawval1*256 + rawval2
         if raw >= 32768
                 raw = raw - 65536
@@ -534,5 +566,23 @@ def convertRaw(rawval1,rawval2)
 	return raw
 end
 
+# converts a raw ASIC power packet of three bytes to a single value
+#
+# @param [Integer] threeBytes[0] first byte-packet of the ASIC wave code
+# @param [Integer] threeBytes[1] second byte-packet of the ASIC wave code
+# @param [Integer] threeBytes[2] third byte-packet of the ASIC wave code
+#
+# @return [Integer] single value generated from the 3 bytes
+def convertToBigEndianInteger(threeBytes)
+  # see MindwaveDataPoints.py at
+  # https://github.com/robintibor/python-mindwave-mobile
+  #
+  bigEndianInteger = (threeBytes[0] << 16) |\
+   (((1 << 16) - 1) & (threeBytes[1] << 8)) |\
+    ((1 << 8) -1) & threeBytes[2]
+  return bigEndianInteger
+end
+
+
 end
 end

data/lib/mindwave/version.rb

@@ -1,4 +1,4 @@
 module Mindwave
 # Versions-Number
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/mindwave.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["code@feedyourhead.at"]
 
   spec.summary       = "mindwave is a ruby-implementation for Neurosky's Mindwave Headset"
-  spec.description   = "This project communicates with the Mindwave Headset. "
-  spec.homepage      = "https://tech.feedyourhead.at"
+  spec.description   = " This gem is a library for Neurosky Mindwave headsets. It reads out EEG-data from the ThinkGear Serial Stream and provides callback-methods for processing the data. this library works for Mindwave and Mindwave-Mobile."
+  spec.homepage      = "https://github.com/whotwagner/mindwave"
   spec.licenses      = ["GPL"]
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindwave
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Wolfgang Hotwagner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 'This project communicates with the Mindwave Headset. '
+description: " This gem is a library for Neurosky Mindwave headsets. It reads out
+  EEG-data from the ThinkGear Serial Stream and provides callback-methods for processing
+  the data. this library works for Mindwave and Mindwave-Mobile."
 email:
 - code@feedyourhead.at
 executables: []
@@ -70,11 +72,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/asicwaves.rb
 - examples/mindwaver.rb
 - lib/mindwave.rb
 - lib/mindwave/version.rb
 - mindwave.gemspec
-homepage: https://tech.feedyourhead.at
+homepage: https://github.com/whotwagner/mindwave
 licenses:
 - GPL
 metadata: {}