source: thinkgear_emulator/puzzlebox_thinkgear_server.py @ 89

Last change on this file since 89 was 89, checked in by sc, 11 years ago
  • preparation for 0.2.0 release
  • Property svn:executable set to *
File size: 12.6 KB
Line 
1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3#
4# Puzzlebox - Brainstorms - Network - Server - ThinkGear
5#
6# Copyright Puzzlebox Productions, LLC (2010)
7#
8# This code is released under the GNU Pulic License (GPL) version 2
9# For more information please refer to http://www.gnu.org/copyleft/gpl.html
10#
11# Last Update: 2010.07.06
12#
13#####################################################################
14
15import os, sys, time
16import signal
17import math
18
19import simplejson as json
20
21from PyQt4 import QtCore, QtNetwork
22
23import puzzlebox_brainstorms_configuration as configuration
24#import puzzlebox_logger
25
26#####################################################################
27# Globals
28#####################################################################
29
30DEBUG = 1
31
32SERVER_INTERFACE = configuration.THINKGEAR_SERVER_INTERFACE
33SERVER_PORT = configuration.THINKGEAR_SERVER_PORT
34
35CLIENT_NO_REPLY_WAIT = configuration.CLIENT_NO_REPLY_WAIT * 1000
36
37FLASH_POLICY_FILE_REQUEST = configuration.FLASH_POLICY_FILE_REQUEST
38FLASH_SOCKET_POLICY_FILE = configuration.FLASH_SOCKET_POLICY_FILE
39
40DELIMITER = configuration.THINKGEAR_DELIMITER
41
42MESSAGE_FREQUENCY_TIMER = 1 * 1000 # 1 Hz (1000 ms)
43
44ENABLE_SIMULATE_HEADSET_DATA = configuration.THINKGEAR_ENABLE_SIMULATE_HEADSET_DATA
45
46BLINK_FREQUENCY_TIMER = configuration.THINKGEAR_BLINK_FREQUENCY_TIMER
47
48DEFAULT_SAMPLE_WAVELENGTH = configuration.THINKGEAR_DEFAULT_SAMPLE_WAVELENGTH
49
50DEFAULT_AUTHORIZATION_MESSAGE = \
51        {"isAuthorized": True}
52                # Tells the client whether the server has authorized
53                # access to the user's headset data. The value is
54                # either true or false.
55
56DEFAULT_SIGNAL_LEVEL_MESSAGE = \
57        {"poorSignalLevel": 0}
58                # A quantifier of the quality of the brainwave signal.
59                # This is an integer value that is generally in the
60                # range of 0 to 200, with 0 indicating a
61                # good signal and 200 indicating an off-head state.
62
63DEFAULT_EEG_POWER_MESSAGE = \
64        {"eegPower": { \
65                'delta': 0, \
66                'theta': 0, \
67                'lowAlpha': 0, \
68                'highAlpha': 0, \
69                'lowBeta': 0, \
70                'highBeta': 0, \
71                'lowGamma': 0, \
72                'highGamma': 0, \
73                }, \
74        } # A container for the EEG powers. These may
75          # be either integer or floating-point values.
76          # Maximum values are undocumented but assumed to be 65535
77
78DEFAULT_ESENSE_MESSAGE = \
79        {"eSense": { \
80                'attention': 0, \
81                'meditation': 0, \
82                }, \
83        } # A container for the eSense™ attributes.
84          # These are integer values between 0 and 100,
85          # where 0 is perceived as a lack of that attribute
86          # and 100 is an excess of that attribute.
87
88DEFAULT_BLINK_MESSAGE = {"blinkStrength": 255}
89        # The strength of a detected blink. This is
90        # an integer in the range of 0-255.
91
92DEFAULT_RAWEEG_MESSAGE = {"rawEeg": 255}
93        # The raw data reading off the forehead sensor.
94        # This may be either an integer or a floating-point value.
95
96DEFAULT_PACKET = {}
97DEFAULT_PACKET.update(DEFAULT_EEG_POWER_MESSAGE)
98DEFAULT_PACKET.update(DEFAULT_SIGNAL_LEVEL_MESSAGE)
99DEFAULT_PACKET.update(DEFAULT_ESENSE_MESSAGE)
100
101DEFAULT_RESPONSE_MESSAGE = DEFAULT_SIGNAL_LEVEL_MESSAGE
102
103#####################################################################
104# Classes
105#####################################################################
106
107class puzzlebox_brainstorms_network_server_thinkgear:
108       
109        def __init__(self, log, \
110                          server_interface=SERVER_INTERFACE, \
111                          server_port=SERVER_PORT, \
112                          DEBUG=DEBUG, \
113                          parent=None):
114               
115                self.log = log
116                self.DEBUG = DEBUG
117               
118                self.server_interface = server_interface
119                self.server_port = server_port
120               
121                self.message_frequency_timer = MESSAGE_FREQUENCY_TIMER
122                self.blink_frequency_timer = BLINK_FREQUENCY_TIMER
123               
124                self.connection_timestamp = time.time()
125                self.blink_timestamp = time.time()
126               
127                self.connections = []
128                self.packet_queue = []
129               
130                self.configureNetwork()
131               
132                self.updateTimer = QtCore.QTimer()
133                QtCore.QObject.connect(self.updateTimer, QtCore.SIGNAL("timeout()"), self.timerEvent)
134                self.updateTimer.start(MESSAGE_FREQUENCY_TIMER)
135       
136       
137        ##################################################################
138       
139        def timerEvent(self):
140               
141                if (self.connections != []):
142                       
143                        self.updateStatus()
144                        self.sendPacketQueue()
145       
146       
147        ##################################################################
148       
149        def configureNetwork(self):
150       
151                #self.blockSize = 0
152                self.socket = QtNetwork.QTcpServer()
153                self.socket.name = 'ThinkGear Server'
154               
155                if self.DEBUG:
156                        print "<---- [%s] Initializing server on %s:%i" % \
157                           (self.socket.name, self.server_interface, self.server_port)
158                       
159                if (self.server_interface == ''):
160                        result = self.socket.listen(port=self.server_port)
161                else:
162                        result = self.socket.listen(address=self.server_interface, \
163                                           port=self.server_port)
164               
165                if not result:
166                        if self.DEBUG:
167                                print "ERROR [%s] Unable to start the server:", self.socket.name,
168                                print self.socket.errorString()
169                               
170                        self.socket.close()
171                        return
172               
173               
174                self.socket.newConnection.connect(self.processConnection)
175                #self.socket.error.connect(self.displayError)
176       
177       
178        ##################################################################
179       
180        def deleteDisconnected(self):
181               
182                connection_index = 0
183               
184                for connection in self.connections:
185                       
186                        if ((connection.state() != QtNetwork.QAbstractSocket.ConnectingState) and \
187                                 (connection.state() != QtNetwork.QAbstractSocket.ConnectedState)):
188                               
189                                if self.DEBUG:
190                                        print "- - [%s] Deleting disconnected socket" % self.socket.name
191                               
192                                connection.deleteLater()
193                                # Delete references to disconnected sockets
194                                del (self.connections[connection_index])
195                       
196                       
197                        connection_index += 1
198       
199       
200        ##################################################################
201       
202        def processConnection(self):
203               
204                clientConnection = self.socket.nextPendingConnection()
205                clientConnection.disconnected.connect(self.deleteDisconnected)
206               
207                self.connections.append(clientConnection)
208               
209               
210                # Wait until client sends authorization request or configuration packet
211                while not clientConnection.waitForReadyRead(CLIENT_NO_REPLY_WAIT):
212                        pass
213               
214                socket_buffer = clientConnection.readAll()
215               
216                for packet in socket_buffer.split(DELIMITER):
217                       
218                        data_to_process = None
219                       
220                        if packet != '':
221                               
222                                try:
223                                        data_to_process = json.loads(packet.data())
224                               
225                                except Exception, e:
226                                       
227                                        # Special socket handling for Flash applications
228                                        if (packet == FLASH_POLICY_FILE_REQUEST):
229                                               
230                                                if self.DEBUG:
231                                                        print "--> [%s] Flash policy file requested" % self.socket.name
232                                               
233                                                data_to_process = packet.data()
234                                       
235                                       
236                                        else:
237                                               
238                                                if self.DEBUG:
239                                                        print "--> [ThinkGear Emulator] Partial data received (or error:",
240                                                        print e
241                                                        print ")."
242                                                       
243                                                        print "packet data:",
244                                                        print packet.data()
245                               
246                               
247                                else:
248                                       
249                                        if self.DEBUG:
250                                                print "--> [%s] Received:" % self.socket.name,
251                                                print data_to_process
252                               
253                               
254                                if (data_to_process != None):
255                                       
256                                        response = self.processData(data_to_process)
257                                       
258                                        if (response != None):
259                                               
260                                                self.sendResponse(clientConnection, response)
261       
262       
263        ##################################################################
264       
265        def sendResponse(self, connection, response, disconnect_after_sending=False):
266               
267                data = json.dumps(response)
268               
269                if connection.waitForConnected(CLIENT_NO_REPLY_WAIT):
270                       
271                        if self.DEBUG:
272                                print "<-- [%s] Sending:" % self.socket.name,
273                                print data
274                       
275                        connection.write(data)
276                       
277                        connection.waitForBytesWritten(CLIENT_NO_REPLY_WAIT)
278                       
279                        if disconnect_after_sending:
280                                connection.disconnectFromHost()
281       
282       
283        ##################################################################
284       
285        def sendPacketQueue(self):
286               
287                while (len(self.packet_queue) > 0):
288                       
289                        packet = self.packet_queue[0]
290                        del self.packet_queue[0]
291                       
292                        for connection in self.connections:
293                               
294                                if connection.state() == QtNetwork.QAbstractSocket.ConnectedState:
295                                       
296                                        self.sendResponse(connection, packet)
297       
298       
299        ##################################################################
300       
301        def processData(self, data):
302               
303                response = None
304               
305                # Special socket handling for Flash applications
306                if (data == FLASH_POLICY_FILE_REQUEST):
307                       
308                        response = FLASH_SOCKET_POLICY_FILE
309                       
310                        self.packet_queue.insert(0, FLASH_SOCKET_POLICY_FILE)
311               
312               
313                elif (type(data) == type({}) and \
314                      data.has_key('appName') and \
315                      data.has_key('appKey')):
316                        authorized = self.authorizeClient(data)
317                       
318                        response = {}
319                        response['isAuthorized'] = authorized
320                       
321                        self.packet_queue.insert(0, response)
322               
323               
324                return(response)
325       
326       
327        ##################################################################
328       
329        def validateChecksum(self, checksum):
330               
331                '''The key used by the client application to identify
332itself. This must be 40 hexadecimal characters, ideally generated
333using an SHA-1 digest. The appKey is an identifier that is unique
334to each application, rather than each instance of an application.
335It is used by the server to bypass the authorization process if a
336user had previously authorized the requesting client. To reduce
337the chance of overlap with the appKey of other applications,
338the appKey should be generated using an SHA-1 digest.'''
339               
340                is_valid = True
341               
342                hexadecimal_characters = '0123456789abcdef'
343               
344                if len(checksum) != 40:
345                        is_valid = False
346                else:
347                        for character in checksum:
348                                if character not in hexadecimal_characters:
349                                        is_valid = False
350               
351                return(is_valid)
352       
353       
354        ##################################################################
355       
356        def authorizeClient(self, data):
357       
358                '''The client must initiate an authorization request
359and the server must authorize the client before the
360server will start transmitting any headset data.'''
361               
362                is_authorized = self.validateChecksum(data['appKey'])
363               
364                # A human-readable name identifying the client
365                # application. This can be a maximum of 255 characters.
366               
367                if len(data['appName']) > 255:
368                        is_authorized = False
369               
370               
371                return(is_authorized)
372       
373       
374        ##################################################################
375       
376        def calculateWavePoint(self, x, max_height=100, wave_length=10):
377               
378                # start at 0, increase to max value at half of one
379                # wavelength, decrease to 0 by end of wavelength
380                y = ( (max_height/2) * \
381                      math.sin ((x-1) * ( math.pi / (wave_length / 2)))) + \
382                      (max_height/2)
383               
384                # start at max value, decrease to 0 at half of one
385                # wavelegnth, increase to max by end of wavelength
386                #y = ( (max_height/2) * \
387                      #math.cos (x * ( math.pi / (wave_length / 2)))) + \
388                      #(max_height/2)
389               
390               
391                return(y)
392       
393       
394        ##################################################################
395       
396        def simulateHeadsetData(self):
397               
398                response = DEFAULT_PACKET
399               
400                time_value = self.connection_timestamp - time.time()
401               
402                for key in response.keys():
403                       
404                        if key == 'poorSignalLevel':
405                                pass
406                       
407                        elif key == 'eSense':
408                                plot = self.calculateWavePoint( \
409                                        time_value, \
410                                        max_height=100, \
411                                        wave_length=DEFAULT_SAMPLE_WAVELENGTH)
412                               
413                                for each in response[key].keys():
414                                        response[key][each] = plot
415                       
416                        elif key == 'eegPower':
417                                plot = self.calculateWavePoint( \
418                                        time_value, \
419                                        max_height=65535, \
420                                        wave_length=DEFAULT_SAMPLE_WAVELENGTH)
421                               
422                                for each in response[key].keys():
423                                        response[key][each] = plot
424               
425               
426                return(response)
427       
428       
429        ##################################################################
430       
431        def updateStatus(self):
432               
433                if ENABLE_SIMULATE_HEADSET_DATA:
434                       
435                        # Craft a simulated data packet
436                        self.packet_queue.append( \
437                                self.simulateHeadsetData() )
438                       
439                        # Include simulated blinks at desired frequency
440                        if ((self.blink_frequency_timer != None) and \
441                            (time.time() - self.blink_timestamp > \
442                             self.blink_frequency_timer)):
443                               
444                                self.blink_timestamp = time.time()
445                               
446                                packet = DEFAULT_BLINK_MESSAGE
447                                self.packet_queue.append(packet)
448
449
450#####################################################################
451# Main
452#####################################################################
453
454if __name__ == '__main__':
455       
456        # Perform correct KeyboardInterrupt handling
457        signal.signal(signal.SIGINT, signal.SIG_DFL)
458       
459        #log = puzzlebox_logger.puzzlebox_logger(logfile='server_thinkgear')
460        log = None
461       
462        # Collect default settings and command line parameters
463        server_interface = SERVER_INTERFACE
464        server_port = SERVER_PORT
465       
466        for each in sys.argv:
467               
468                if each.startswith("--interface="):
469                        server_interface = each[ len("--interface="): ]
470                if each.startswith("--port="):
471                        server_port = each[ len("--port="): ]
472       
473       
474        app = QtCore.QCoreApplication(sys.argv)
475       
476        server = puzzlebox_brainstorms_network_server_thinkgear(log, \
477                                                                server_interface, \
478                                                                server_port, \
479                                                                DEBUG=DEBUG)
480       
481        sys.exit(app.exec_())
482
Note: See TracBrowser for help on using the repository browser.