source: thinkgear_emulator/puzzlebox_thinkgear_server.py @ 100

Last change on this file since 100 was 100, checked in by sc, 11 years ago

thinkgear_emulator/puzzlebox_thinkgear_server.py:

  • error message bugfix

remote_control/puzzlebox_brainstorms_client_interface.py:

  • To Do notes updated

remote_control/puzzlebox_brainstorms_client_interface_local.py:

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