Programming Reference:SignalSharing Python Demo - Revision history

Mellinger: /* Source vs Client */

2026-03-12T15:39:57Z

Source vs Client

← Older revision		Revision as of 15:39, 12 March 2026
Line 16:		Line 16:
	The BCI2000 data is sent according to the format specified in [[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=1:_Signal_Data\|BCI2000 Messages Wiki page]], as ''Descriptor=4: Visualization and Brain Signal Data Format'', then ''Descriptor Supplement=1: Signal Data'', then ''data type 2''.		The BCI2000 data is sent according to the format specified in [[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=1:_Signal_Data\|BCI2000 Messages Wiki page]], as ''Descriptor=4: Visualization and Brain Signal Data Format'', then ''Descriptor Supplement=1: Signal Data'', then ''data type 2''.

	With this demo, '''BCI2000 and the Python script must be run on the same computer'''. The script expects the data stream to be sending the name of the shared memory, which will only happen if they are both on the same computer. It is possible to grab BCI2000 data from another computer, and is implemented in the [[Programming Reference:SignalSharingDemo Signal Processing\|C++ SignalSharing Demo]]. If on separate computers, the actual data points are being shared instead of the memory name. Implementing this would require a simple extension of this demo.		With this demo, '''BCI2000 and the Python script must be run on the same computer'''. The script expects the data stream to be sending the name of the shared memory, which will only happen if they are both on the same computer. It is possible to grab BCI2000 data from another computer, and is implemented in the [[Programming Reference:SignalSharingDemo Signal Processing\|C++ SignalSharing Demo]] and the [[Programming Reference:SignalSharingClientLibDemo\|SignalSharing Client Lib Demo]]
			. If on separate computers, the actual data points are being shared instead of the memory name. Implementing this would require a simple extension of this demo.

	==How to run==		==How to run==

Mellinger: /* See also */

2026-03-12T15:37:35Z

Mellinger: /* Conclusion */

2024-10-22T18:16:10Z

Conclusion

← Older revision		Revision as of 18:16, 22 October 2024
Line 386:		Line 386:
	==Conclusion==		==Conclusion==
	This demo shows how to grab data from BCI2000 and plot it in Python! The main advantage of this demo shows how to access the data in Python. Once this is done, Python's extensive library can be used to create complex, real-time visualizations and calculations!		This demo shows how to grab data from BCI2000 and plot it in Python! The main advantage of this demo shows how to access the data in Python. Once this is done, Python's extensive library can be used to create complex, real-time visualizations and calculations!
			Also, this demo shows how to modify BCI2000 signals and states from Python.

	==See also==		==See also==

Mellinger: /* Python Script */

2024-10-22T18:14:52Z

Python Script

← Older revision		Revision as of 18:14, 22 October 2024
Line 29:		Line 29:

	==Python Script==		==Python Script==
	Here is the same code that is on the SVN (~~r8387~~)		Here is the same code that is on the SVN (r8388)
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	#! /usr/bin/env python3		#! /usr/bin/env python3
Line 100:		Line 100:
	b = n.to_bytes(fieldSize, 'little')		b = n.to_bytes(fieldSize, 'little')
	stream.write(b)		stream.write(b)
	b = n.to_string()		b = value.to_string()
	stream.write(b)		stream.write(b)
	stream.write(b'\x00')		stream.write(b'\x00')

Mellinger: /* How to run */

2024-10-22T18:12:24Z

How to run

← Older revision		Revision as of 18:12, 22 October 2024
Line 26:		Line 26:
	#* If you change the Parameter ''ShareTransmissionFilter'', make sure to also change it in the Python script		#* If you change the Parameter ''ShareTransmissionFilter'', make sure to also change it in the Python script
	# '''In the visualization window''', pressing the ''Set Running 0'' button will set the ''Running'' state to 0, stopping BCI2000. This is an example how to modify state values from the Python side.		# '''In the visualization window''', pressing the ''Set Running 0'' button will set the ''Running'' state to 0, stopping BCI2000. This is an example how to modify state values from the Python side.
	# '''In the visualization window''', pressing the ''Insert NaNs'' button will insert a data block of NaNs into the BCI2000 processing chain. In the ''SpatialFilter'' signal visualization, you will be able to see the NaN block in form of an empty area in the display.		# '''In the visualization window''', pressing the ''Insert NaNs'' button will insert a data block of NaNs into the BCI2000 processing chain. In the ''SpatialFilter'' signal visualization, you will be able to see the NaN block in form of an empty area in the display. This is an example of how to modify signal values from the Python side.

	==Python Script==		==Python Script==

Mellinger: /* How to run */

2024-10-22T18:11:52Z

How to run

← Older revision		Revision as of 18:11, 22 October 2024
Line 25:		Line 25:
	# '''Run the batch file''', and press "Start Run" (it already sets the configuration, it won't work it you press it multiple times)		# '''Run the batch file''', and press "Start Run" (it already sets the configuration, it won't work it you press it multiple times)
	#* If you change the Parameter ''ShareTransmissionFilter'', make sure to also change it in the Python script		#* If you change the Parameter ''ShareTransmissionFilter'', make sure to also change it in the Python script
			# '''In the visualization window''', pressing the ''Set Running 0'' button will set the ''Running'' state to 0, stopping BCI2000. This is an example how to modify state values from the Python side.
			# '''In the visualization window''', pressing the ''Insert NaNs'' button will insert a data block of NaNs into the BCI2000 processing chain. In the ''SpatialFilter'' signal visualization, you will be able to see the NaN block in form of an empty area in the display.

	==Python Script==		==Python Script==

Mellinger: /* Python Script */

2024-10-22T18:05:29Z

Python Script

Show changes

Mellinger: /* Python Script */

2024-10-16T15:40:29Z

Python Script

← Older revision		Revision as of 15:40, 16 October 2024
Line 27:		Line 27:

	==Python Script==		==Python Script==
	Here is the same code that is on the SVN (~~r8380~~)		Here is the same code that is on the SVN (r8382)
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	#! /usr/bin/env python3		#! /usr/bin/env python3
Line 229:		Line 229:
	msg = receiveBciMessage(stream)		msg = receiveBciMessage(stream)

	if msg.kind == 'signal properties':		if msg.kind == 'signal properties' and msg.sourceID == 'Signal':
	CHANNELS = msg.channels		CHANNELS = msg.channels
	chNames = range(1,CHANNELS+1)		chNames = range(1,CHANNELS+1)
Line 242:		Line 242:
	print("Properties: Channels: %i, Elements: %i" %(CHANNELS, ELEMENTS))		print("Properties: Channels: %i, Elements: %i" %(CHANNELS, ELEMENTS))

	elif msg.kind == 'signal':		elif msg.kind == 'signal properties' and msg.sourceID == 'States':
	if msg.~~channels~~ == 0 and msg.~~elements~~ == 0:		pass
	~~continue;~~
			elif msg.kind == 'signal' and msg.sourceID == 'Signal':

	if msg.channels != CHANNELS:		if msg.channels != CHANNELS:
Line 276:		Line 277:
	elif msg.kind == 'parameter':		elif msg.kind == 'parameter':
	continue		continue

			elif msg.kind == 'signal' and msg.sourceID == 'States':
			pass

			elif msg.kind == 'signal' and msg.sourceID == '': # empty signal message indicates EOT
			if msg.channels == 0 and msg.elements == 0:
			continue;

	else:		else:

Mellinger: /* Python Script */

2024-10-15T15:06:22Z

Python Script

← Older revision		Revision as of 15:06, 15 October 2024
Line 27:		Line 27:

	==Python Script==		==Python Script==
	Here is the same code that is on the SVN (~~r8100~~)		Here is the same code that is on the SVN (r8380)
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	#! /usr/bin/env python3		#! /usr/bin/env python3

Mellinger: /* Python Script */

2024-10-15T15:05:38Z

Python Script

← Older revision		Revision as of 15:05, 15 October 2024
Line 69:		Line 69:
	SignalProperties = b'\x04\x03'		SignalProperties = b'\x04\x03'
	SignalData = b'\x04\x01'		SignalData = b'\x04\x01'
			Parameter = b'\x02\x00'

	def readBciLengthField(stream, fieldSize):		def readBciLengthField(stream, fieldSize):
Line 173:		Line 174:

	return signal		return signal

			def parseBciParameter(stream):
			"""parse a raw parameter message into an object"""
			param = Object()
			param.kind = 'parameter'

			return param;

	def receiveBciMessage(stream):		def receiveBciMessage(stream):
Line 182:		Line 190:
	elif descsupp == BciDescSupp.SignalData.value:		elif descsupp == BciDescSupp.SignalData.value:
	return parseBciSignalData(stream2)		return parseBciSignalData(stream2)
			elif descsupp == BciDescSupp.Parameter.value:
			return parseBciParameter(stream2)
	else:		else:
	raise RuntimeError('Unexpected BCI2000 message type')		raise RuntimeError('Unexpected BCI2000 message type')
Line 263:		Line 273:
	figure.canvas.draw()		figure.canvas.draw()
	plt.pause(0.01) #render update		plt.pause(0.01) #render update

			elif msg.kind == 'parameter':
			continue

	else:		else:
	raise ~~RuntimeException~~('Unexpected message')		raise RuntimeError('Unexpected BCI2000 message')

	except EOFError:		except EOFError:

← Older revision		Revision as of 15:37, 12 March 2026
Line 389:		Line 389:

	==See also==		==See also==
			[[Programming Reference:SignalSharingClientLibDemo]],
	[[Programming Reference:SignalSharingDemoClient C++ App]], [[Technical Reference:BCI2000 Messages]], [[User Tutorial:BCI2000Remote]]		[[Programming Reference:SignalSharingDemoClient C++ App]], [[Technical Reference:BCI2000 Messages]], [[User Tutorial:BCI2000Remote]]

	[[Category:Howto]][[Category:Development]]		[[Category:Howto]][[Category:Development]]