README.md in mindwave-0.1.3 vs README.md in mindwave-0.1.4

- old
+ new

@@ -2,16 +2,15 @@ [![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.png?v=103)](https://github.com/whotwagner/mindwave/blob/master/LICENSE.txt) [![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. +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. -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. - ## Installation ### Install from rubygems.org ``` @@ -91,10 +90,56 @@ 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 +``` + ## Documentation [rubydoc.info](http://www.rubydoc.info/github/whotwagner/mindwave/master) ## Resources @@ -104,11 +149,9 @@ * https://github.com/BarkleyUS/mindwave-python ## Development 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.