322 lines
14 KiB
Python
322 lines
14 KiB
Python
##Copyright (c) 2013, sahil singh
|
|
##
|
|
##All rights reserved.
|
|
##
|
|
##Redistribution and use in source and binary forms, with or without modification,
|
|
##are permitted provided that the following conditions are met:
|
|
##
|
|
## * Redistributions of source code must retain the above copyright notice,
|
|
## this list of conditions and the following disclaimer.
|
|
## * Redistributions in binary form must reproduce the above copyright notice,
|
|
## this list of conditions and the following disclaimer in the documentation
|
|
## and/or other materials provided with the distribution.
|
|
## * Neither the name of NeuroPy nor the names of its contributors
|
|
## may be used to endorse or promote products derived from this software
|
|
## without specific prior written permission.
|
|
##
|
|
##THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
##"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
##LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
##A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
|
##CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
##EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
##PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
##PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
##LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
##NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
##SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import serial
|
|
import thread
|
|
|
|
class NeuroPy(object):
|
|
"""NeuroPy libraby, to get data from neurosky mindwave.
|
|
Initialising: object1=NeuroPy("COM6",57600) #windows
|
|
After initialising , if required the callbacks must be set
|
|
then using the start method the library will start fetching data from mindwave
|
|
i.e. object1.start()
|
|
similarly stop method can be called to stop fetching the data
|
|
i.e. object1.stop()
|
|
|
|
The data from the device can be obtained using either of the following methods or both of them together:
|
|
|
|
Obtaining value: variable1=object1.attention #to get value of attention
|
|
#other variables: attention,meditation,rawValue,delta,theta,lowAlpha,highAlpha,lowBeta,highBeta,lowGamma,midGamma, poorSignal and blinkStrength
|
|
|
|
Setting callback:a call back can be associated with all the above variables so that a function is called when the variable is updated. Syntax: setCallBack("variable",callback_function)
|
|
for eg. to set a callback for attention data the syntax will be setCallBack("attention",callback_function)"""
|
|
__attention=0
|
|
__meditation=0
|
|
__rawValue=0
|
|
__delta=0
|
|
__theta=0
|
|
__lowAlpha=0
|
|
__highAlpha=0
|
|
__lowBeta=0
|
|
__highBeta=0
|
|
__lowGamma=0
|
|
__midGamma=0
|
|
__poorSignal=0
|
|
__blinkStrength=0
|
|
srl=None
|
|
__port=None
|
|
__baudRate=None
|
|
__mindFlexHack=False
|
|
|
|
threadRun=True #controlls the running of thread
|
|
callBacksDictionary={} #keep a track of all callbacks
|
|
def __init__(self,port,baudRate=57600,mindFlexHack=False):
|
|
self.__port,self.__baudRate,self.__mindFlexHack=port,baudRate,mindFlexHack
|
|
|
|
def __del__(self):
|
|
self.srl.close()
|
|
|
|
def start(self):
|
|
"""starts packetparser in a separate thread"""
|
|
self.threadRun=True
|
|
self.srl=serial.Serial(self.__port,self.__baudRate)
|
|
if self.__mindFlexHack:
|
|
"""
|
|
emit the magic hex sequence for a MindFlex toy set up to run at 57600 baud
|
|
using the hack described here:
|
|
http://www.instructables.com/id/Mindflex-EEG-with-raw-data-over-Bluetooth/
|
|
"""
|
|
self.srl.write(b'\x00\xF8\x00\x00\x00\xE0')
|
|
thread.start_new_thread(self.__packetParser,(self.srl,))
|
|
|
|
def __packetParser(self,srl):
|
|
"packetParser runs continously in a separate thread to parse packets from mindwave and update the corresponding variables"
|
|
#srl.open()
|
|
while self.threadRun:
|
|
p1=srl.read(1).encode("hex") #read first 2 packets
|
|
p2=srl.read(1).encode("hex")
|
|
while p1!='aa' or p2!='aa':
|
|
p1=p2
|
|
p2=srl.read(1).encode("hex")
|
|
else:
|
|
#a valid packet is available
|
|
payload=[]
|
|
checksum=0;
|
|
payloadLength=int(srl.read(1).encode("hex"),16)
|
|
for i in range(payloadLength):
|
|
tempPacket=srl.read(1).encode("hex")
|
|
payload.append(tempPacket)
|
|
checksum+=int(tempPacket,16)
|
|
checksum=~checksum&0x000000ff
|
|
if checksum==int(srl.read(1).encode("hex"),16):
|
|
i=0
|
|
while i<payloadLength:
|
|
code=payload[i]
|
|
if(code=='02'):#poorSignal
|
|
i=i+1; self.poorSignal=int(payload[i],16)
|
|
elif(code=='04'):#attention
|
|
i=i+1; self.attention=int(payload[i],16)
|
|
elif(code=='05'):#meditation
|
|
i=i+1; self.meditation=int(payload[i],16)
|
|
elif(code=='16'):#blink strength
|
|
i=i+1; self.blinkStrength=int(payload[i],16)
|
|
elif(code=='80'):#raw value
|
|
i=i+1 #for length/it is not used since length =1 byte long and always=2
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; self.rawValue=val0*256+int(payload[i],16)
|
|
if self.rawValue>32768 :
|
|
self.rawValue=self.rawValue-65536
|
|
elif(code=='83'):#ASIC_EEG_POWER
|
|
i=i+1;#for length/it is not used since length =1 byte long and always=2
|
|
#delta:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.delta=val0*65536+val1*256+int(payload[i],16)
|
|
#theta:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.theta=val0*65536+val1*256+int(payload[i],16)
|
|
#lowAlpha:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.lowAlpha=val0*65536+val1*256+int(payload[i],16)
|
|
#highAlpha:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.highAlpha=val0*65536+val1*256+int(payload[i],16)
|
|
#lowBeta:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.lowBeta=val0*65536+val1*256+int(payload[i],16)
|
|
#highBeta:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.highBeta=val0*65536+val1*256+int(payload[i],16)
|
|
#lowGamma:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.lowGamma=val0*65536+val1*256+int(payload[i],16)
|
|
#midGamma:
|
|
i=i+1; val0=int(payload[i],16)
|
|
i=i+1; val1=int(payload[i],16)
|
|
i=i+1; self.midGamma=val0*65536+val1*256+int(payload[i],16)
|
|
else:
|
|
pass
|
|
i=i+1
|
|
|
|
|
|
|
|
def stop(self):
|
|
"stops packetparser's thread and releases com port i.e disconnects mindwave"
|
|
self.threadRun=False
|
|
self.srl.close()
|
|
|
|
|
|
|
|
|
|
def setCallBack(self,variable_name,callback_function):
|
|
"""Setting callback:a call back can be associated with all the above variables so that a function is called when the variable is updated. Syntax: setCallBack("variable",callback_function)
|
|
for eg. to set a callback for attention data the syntax will be setCallBack("attention",callback_function)"""
|
|
self.callBacksDictionary[variable_name]=callback_function
|
|
|
|
#setting getters and setters for all variables
|
|
|
|
#attention
|
|
@property
|
|
def attention(self):
|
|
"Get value for attention"
|
|
return self.__attention
|
|
@attention.setter
|
|
def attention(self,value):
|
|
self.__attention=value
|
|
if self.callBacksDictionary.has_key("attention"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["attention"](self.__attention)
|
|
|
|
#meditation
|
|
@property
|
|
def meditation(self):
|
|
"Get value for meditation"
|
|
return self.__meditation
|
|
@meditation.setter
|
|
def meditation(self,value):
|
|
self.__meditation=value
|
|
if self.callBacksDictionary.has_key("meditation"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["meditation"](self.__meditation)
|
|
|
|
#rawValue
|
|
@property
|
|
def rawValue(self):
|
|
"Get value for rawValue"
|
|
return self.__rawValue
|
|
@rawValue.setter
|
|
def rawValue(self,value):
|
|
self.__rawValue=value
|
|
if self.callBacksDictionary.has_key("rawValue"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["rawValue"](self.__rawValue)
|
|
|
|
#delta
|
|
@property
|
|
def delta(self):
|
|
"Get value for delta"
|
|
return self.__delta
|
|
@delta.setter
|
|
def delta(self,value):
|
|
self.__delta=value
|
|
if self.callBacksDictionary.has_key("delta"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["delta"](self.__delta)
|
|
|
|
#theta
|
|
@property
|
|
def theta(self):
|
|
"Get value for theta"
|
|
return self.__theta
|
|
@theta.setter
|
|
def theta(self,value):
|
|
self.__theta=value
|
|
if self.callBacksDictionary.has_key("theta"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["theta"](self.__theta)
|
|
|
|
#lowAlpha
|
|
@property
|
|
def lowAlpha(self):
|
|
"Get value for lowAlpha"
|
|
return self.__lowAlpha
|
|
@lowAlpha.setter
|
|
def lowAlpha(self,value):
|
|
self.__lowAlpha=value
|
|
if self.callBacksDictionary.has_key("lowAlpha"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["lowAlpha"](self.__lowAlpha)
|
|
|
|
#highAlpha
|
|
@property
|
|
def highAlpha(self):
|
|
"Get value for highAlpha"
|
|
return self.__highAlpha
|
|
@highAlpha.setter
|
|
def highAlpha(self,value):
|
|
self.__highAlpha=value
|
|
if self.callBacksDictionary.has_key("highAlpha"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["highAlpha"](self.__highAlpha)
|
|
|
|
|
|
#lowBeta
|
|
@property
|
|
def lowBeta(self):
|
|
"Get value for lowBeta"
|
|
return self.__lowBeta
|
|
@lowBeta.setter
|
|
def lowBeta(self,value):
|
|
self.__lowBeta=value
|
|
if self.callBacksDictionary.has_key("lowBeta"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["lowBeta"](self.__lowBeta)
|
|
|
|
#highBeta
|
|
@property
|
|
def highBeta(self):
|
|
"Get value for highBeta"
|
|
return self.__highBeta
|
|
@highBeta.setter
|
|
def highBeta(self,value):
|
|
self.__highBeta=value
|
|
if self.callBacksDictionary.has_key("highBeta"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["highBeta"](self.__highBeta)
|
|
|
|
#lowGamma
|
|
@property
|
|
def lowGamma(self):
|
|
"Get value for lowGamma"
|
|
return self.__lowGamma
|
|
@lowGamma.setter
|
|
def lowGamma(self,value):
|
|
self.__lowGamma=value
|
|
if self.callBacksDictionary.has_key("lowGamma"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["lowGamma"](self.__lowGamma)
|
|
|
|
#midGamma
|
|
@property
|
|
def midGamma(self):
|
|
"Get value for midGamma"
|
|
return self.__midGamma
|
|
@midGamma.setter
|
|
def midGamma(self,value):
|
|
self.__midGamma=value
|
|
if self.callBacksDictionary.has_key("midGamma"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["midGamma"](self.__midGamma)
|
|
|
|
#poorSignal
|
|
@property
|
|
def poorSignal(self):
|
|
"Get value for poorSignal"
|
|
return self.__poorSignal
|
|
@poorSignal.setter
|
|
def poorSignal(self,value):
|
|
self.__poorSignal=value
|
|
if self.callBacksDictionary.has_key("poorSignal"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["poorSignal"](self.__poorSignal)
|
|
|
|
#blinkStrength
|
|
@property
|
|
def blinkStrength(self):
|
|
"Get value for blinkStrength"
|
|
return self.__blinkStrength
|
|
@blinkStrength.setter
|
|
def blinkStrength(self,value):
|
|
self.__blinkStrength=value
|
|
if self.callBacksDictionary.has_key("blinkStrength"): #if callback has been set, execute the function
|
|
self.callBacksDictionary["blinkStrength"](self.__blinkStrength)
|