Contributions:DSISerial - Revision history

Jhill: /* States */

2025-01-09T16:48:56Z

States

← Older revision		Revision as of 16:48, 9 January 2025
Line 189:		Line 189:
	===HeadsetBattery1===		===HeadsetBattery1===

	Reports the estimated battery level of the first battery in percent.		Reports the estimated battery level of the first battery in percent. If there is no battery in the first slot,
			the value will be 0.

	===HeadsetBattery2===		===HeadsetBattery2===
	Reports the estimated battery level of the second battery in percent. If there is no second ~~battery~~,		Reports the estimated battery level of the second battery in percent. If there is no battery in the second slot,
	value will be 0.		the value will be 0.

	===HeadsetAlarm===		===HeadsetAlarm===
Line 200:		Line 201:
	===BufferedSamples===		===BufferedSamples===
	For debugging.		For debugging.

	==Streams==		==Streams==
	===Trigger===		===Trigger===

Jhill at 16:47, 9 January 2025

2025-01-09T16:47:13Z

← Older revision		Revision as of 16:47, 9 January 2025
Line 54:		Line 54:
	===UnfilteredChannels===		===UnfilteredChannels===

	This parameter is made available by ~~later revisions (r4730+) of~~ the [[User_Reference:SourceFilter\|SourceFilter]] framework component.		This parameter is made available by the [[User_Reference:SourceFilter\|SourceFilter]] framework component in svn r4730+.
	List any channels here that you want to remain unfiltered (if you are recording		List any channels here that you want to remain unfiltered (if you are recording
	the DSI headset's digital trigger channel <tt>TRG</tt> or the two timing-debugging channels		the DSI headset's digital trigger channel <tt>TRG</tt> or the two timing-debugging channels
Line 119:		Line 119:
	leading to potentially unorthodox-looking EEG signals).		leading to potentially unorthodox-looking EEG signals).

	The '''DefaultReference''' is only applied to signals that the headset flags as being part of the referential EEG montage—it will not be applied to auxiliary bipolar sensors, to the trigger <tt>TRG</tt>, or to the clock signals <tt>SND</tt> and <tt>RCV</tt>.		The '''DefaultReference''' is only applied to signals that the headset flags as being part of the referential EEG montage—it will not be applied to auxiliary bipolar sensors, to the trigger <tt>TRG</tt>, to accelerometer-based signals, or to the clock signals <tt>SND</tt> and <tt>RCV</tt>.

	===HeadsetDescription===		===HeadsetDescription===
Line 138:		Line 138:

	For headsets with built-in accelerometers, this specifies the frequency at which to		For headsets with built-in accelerometers, this specifies the frequency at which to
	sample the accelerometer data. 100Hz is often a good choice. Setting this to 0 disables the accelerometer. It must be 0 for headsets without an accelerometer. The default accelerometer channels are called ACCX, ACCY and ACCZ. Hidden by default, but available if they are specified in the '''ChannelNames''' or '''Montage''' parameter, are ACCT (a time-base for the accelerometer readings) and JERK (magnitude of the derivative of vector the three accelerometer readings).		sample the accelerometer data. 100Hz is often a good choice. Setting this to 0 disables the accelerometer. It must be 0 for headsets without an accelerometer. The default accelerometer channels are called <tt>ACCX</tt>, <tt>ACCY</tt> and <tt>ACCZ</tt>. Hidden by default, but available if they are specified in the '''ChannelNames''' or '''Montage''' parameter, are <tt>ACCT</tt> (a time-base for the accelerometer readings) and <tt>JERK</tt> (magnitude of the derivative of vector the three accelerometer readings).

	===ImpedanceDriverOn===		===ImpedanceDriverOn===
Line 203:		Line 203:
	===Trigger===		===Trigger===

	Streams the trigger channel from the DSI. This will only work when used in tandem with a trigger box such as the gTRIGBox, the SyncGenie, or Wearable Sensing's own Wireless Trigger Hub.		Streams the trigger channel from the DSI. This will only work when used in tandem with a trigger box such as the gTRIGBox, the SyncGenie, or Wearable Sensing's own Wireless Trigger Hub.

			(NB: the trigger signal is also available as a channel of the main signal stream, if you request <tt>TRG</tt> in '''ChannelNames''' or '''Montage'''; you can also request <tt>TRG:0</tt> through <tt>TRG:7</tt> as channels if you want to work with individual bits of <tt>TRG</tt>.)

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

Jhill: /* DSIAPI */

2025-01-09T04:36:47Z

DSIAPI

← Older revision		Revision as of 04:36, 9 January 2025
Line 162:		Line 162:
	developer's API for the headset. Usually, it will be filled in with a platform-		developer's API for the headset. Usually, it will be filled in with a platform-
	appropriate default and the library will be expected to be found in the same		appropriate default and the library will be expected to be found in the same
	directory as the source module executable. If you wish to change this, you must		directory as the source module executable.
			<!-- If you wish to change this, you must
	specify it on the command line when you launch the module - for example:		specify it on the command line when you launch the module - for example:

Line 168:		Line 169:

	This parameter is displayed in the System tab of the config dialog and is		This parameter is displayed in the System tab of the config dialog and is
	read-only after launch.		read-only after launch. -->

	===DSIAPIVersion===		===DSIAPIVersion===

Jhill: /* Versioning */

2025-01-09T04:13:39Z

Versioning

← Older revision		Revision as of 04:13, 9 January 2025
Line 13:		Line 13:
	* Revision r6220 2021/02/12 abelsten: minor code modifications and verified basic function of source module		* Revision r6220 2021/02/12 abelsten: minor code modifications and verified basic function of source module
	* Revision r6359 2021/08/16 wengelhardt: Updated DSI API to version 1.18.0		* Revision r6359 2021/08/16 wengelhardt: Updated DSI API to version 1.18.0
			* Revision r8534 2025/01/08 jhill: Recent changes support switching between 300Hz and 600Hz sampling rate on some headsets, parameterize the accelerometer sampling frequency, and greatly improve timing smoothness when using DSI API 1.19+. (As of this revision, the DSI API is now version 1.20.1)

	===Source Code Revisions===		===Source Code Revisions===

	* Initial development: 4528, 6220 (Windows) and 4369 (OSX) but requires some small modifications to the framework's [[User_Reference:SourceFilter\|SourceFilter.cpp]] from later revisions, e.g. r4730, to support the '''UnfilteredChannels''' parameter		* Initial development: 4528, 6220 (Windows) and 4369 (OSX) but requires some small modifications to the framework's [[User_Reference:SourceFilter\|SourceFilter.cpp]] from later revisions, e.g. r4730, to support the '''UnfilteredChannels''' parameter
	* Tested under: ~~4528~~, (Windows) and 4369 (OSX)		* Tested under: 8534, (Windows) and 4369 (OSX)
	* Known to compile under: ~~6359~~		* Known to compile under: 8534
	* Broken since: --		* Broken since: --

Jhill at 04:06, 9 January 2025

2025-01-09T04:06:53Z

← Older revision		Revision as of 04:06, 9 January 2025
Line 40:		Line 40:

	These parameters are the same as for other BCI2000 source modules. For current headsets (as at Oct 2014),		These parameters are the same as for other BCI2000 source modules. For current headsets (as at Oct 2014),
	the '''SamplingRate''' should ~~always~~ be ~~300~~. ~~That means~~ '''SampleBlockSize'''=9 gives you 30ms blocks,		the '''SamplingRate''' should be 300Hz or (for headsets that support it) 600Hz. At 300Hz, '''SampleBlockSize'''=9 gives you 30ms blocks,
	12 gives you 40ms, 15 gives you 50ms, and so on. The '''SourceChOffset''' values should be all 0 and the		12 gives you 40ms, 15 gives you 50ms, and so on. The '''SourceChOffset''' values should be all 0 and the
	'''SourceChGain''' values should be all 1.		'''SourceChGain''' values should be all 1.
Line 133:		Line 133:
	you have to explicitly append the "ms" to the number, otherwise it will be		you have to explicitly append the "ms" to the number, otherwise it will be
	interpreted as a number of SampleBlocks.		interpreted as a number of SampleBlocks.

			===AccelerometerRate===

			For headsets with built-in accelerometers, this specifies the frequency at which to
			sample the accelerometer data. 100Hz is often a good choice. Setting this to 0 disables the accelerometer. It must be 0 for headsets without an accelerometer. The default accelerometer channels are called ACCX, ACCY and ACCZ. Hidden by default, but available if they are specified in the '''ChannelNames''' or '''Montage''' parameter, are ACCT (a time-base for the accelerometer readings) and JERK (magnitude of the derivative of vector the three accelerometer readings).

	===ImpedanceDriverOn===		===ImpedanceDriverOn===
Line 149:		Line 154:
	on it and enable "Show Numeric Values", or you will not see anything. Enable		on it and enable "Show Numeric Values", or you will not see anything. Enable
	"Show Baselines" too, to make it clearer.		"Show Baselines" too, to make it clearer.

	===DSIAPI===		===DSIAPI===

	~~NOTE: This parameter is not functional on versions > r6220.~~

	(in the "System" tab)		(in the "System" tab)

Line 199:		Line 201:
	===Trigger===		===Trigger===

	Streams the trigger channel from the DSI. This will only work when used in tandem with a trigger box such as the gTRIGBox or ~~the~~ Wearable Sensing Wireless Trigger Hub.		Streams the trigger channel from the DSI. This will only work when used in tandem with a trigger box such as the gTRIGBox, the SyncGenie, or Wearable Sensing's own Wireless Trigger Hub.

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

Nluczak at 20:23, 17 May 2022

2022-05-17T20:23:46Z

← Older revision		Revision as of 20:23, 17 May 2022
Line 196:		Line 196:
	===BufferedSamples===		===BufferedSamples===
	For debugging.		For debugging.
			==Streams==
			===Trigger===

			Streams the trigger channel from the DSI. This will only work when used in tandem with a trigger box such as the gTRIGBox or the Wearable Sensing Wireless Trigger Hub.

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

Wengelhardt at 22:58, 16 August 2021

2021-08-16T22:58:51Z

← Older revision		Revision as of 22:58, 16 August 2021
Line 12:		Line 12:
	* Revision 1.0 2014/10/21 jhill: first commit		* Revision 1.0 2014/10/21 jhill: first commit
	* Revision r6220 2021/02/12 abelsten: minor code modifications and verified basic function of source module		* Revision r6220 2021/02/12 abelsten: minor code modifications and verified basic function of source module
			* Revision r6359 2021/08/16 wengelhardt: Updated DSI API to version 1.18.0

	===Source Code Revisions===		===Source Code Revisions===
Line 17:		Line 18:
	* Initial development: 4528, 6220 (Windows) and 4369 (OSX) but requires some small modifications to the framework's [[User_Reference:SourceFilter\|SourceFilter.cpp]] from later revisions, e.g. r4730, to support the '''UnfilteredChannels''' parameter		* Initial development: 4528, 6220 (Windows) and 4369 (OSX) but requires some small modifications to the framework's [[User_Reference:SourceFilter\|SourceFilter.cpp]] from later revisions, e.g. r4730, to support the '''UnfilteredChannels''' parameter
	* Tested under: 4528, (Windows) and 4369 (OSX)		* Tested under: 4528, (Windows) and 4369 (OSX)
	* Known to compile under: ~~6220~~		* Known to compile under: 6359
	* Broken since: --		* Broken since: --

Abelsten: /* Version History */

2021-02-12T22:30:22Z

Version History

← Older revision		Revision as of 22:30, 12 February 2021
Line 11:		Line 11:
	===Version History===		===Version History===
	* Revision 1.0 2014/10/21 jhill: first commit		* Revision 1.0 2014/10/21 jhill: first commit
	* Revision ~~1.1~~ 2021/02/12 abelsten: minor code modifications and verified basic function of source module		* Revision r6220 2021/02/12 abelsten: minor code modifications and verified basic function of source module

	===Source Code Revisions===		===Source Code Revisions===

Abelsten at 22:29, 12 February 2021

2021-02-12T22:29:48Z

← Older revision		Revision as of 22:29, 12 February 2021
Line 11:		Line 11:
	===Version History===		===Version History===
	* Revision 1.0 2014/10/21 jhill: first commit		* Revision 1.0 2014/10/21 jhill: first commit
			* Revision 1.1 2021/02/12 abelsten: minor code modifications and verified basic function of source module

	===Source Code Revisions===		===Source Code Revisions===

	* Initial development: 4528 (Windows) and 4369 (OSX) but requires some small modifications to the framework's [[User_Reference:SourceFilter\|SourceFilter.cpp]] from later revisions, e.g. r4730, to support the '''UnfilteredChannels''' parameter		* Initial development: 4528, 6220 (Windows) and 4369 (OSX) but requires some small modifications to the framework's [[User_Reference:SourceFilter\|SourceFilter.cpp]] from later revisions, e.g. r4730, to support the '''UnfilteredChannels''' parameter
	* Tested under: 4528 (Windows) and 4369 (OSX)		* Tested under: 4528, (Windows) and 4369 (OSX)
	* Known to compile under: ~~4730~~		* Known to compile under: 6220
	* Broken since: ~~4731~~		* Broken since: --

	==Functional Description==		==Functional Description==
Line 149:		Line 150:

	===DSIAPI===		===DSIAPI===

			NOTE: This parameter is not functional on versions > r6220.

	(in the "System" tab)		(in the "System" tab)

Jhill: /* Installation */

2014-11-23T23:18:10Z

Installation

← Older revision		Revision as of 23:18, 23 November 2014
Line 31:		Line 31:

	==Installation==		==Installation==
	~~Requires~~ the <tt>libDSI</tt> dynamic library (<tt>.dll</tt> or <tt>.dylib</tt>) corresponding to your platform. This is part of the manufacturer's API. ~~This~~ must be placed in the <tt>prog</tt> directory. Compiled versions of the dynamic library for 32-bit Windows and 64-bit OSX are supplied in the <tt>DSI_API</tt> subdirectory, and the appropriate one will be copied to prog during the build process.		The <tt>DSISerial</tt> source module requires the <tt>libDSI</tt> dynamic library (a <tt>.dll</tt> or <tt>.dylib</tt> file) corresponding to your platform. This is part of the manufacturer's API. The file must be placed in the <tt>prog</tt> directory. Compiled versions of the dynamic library for 32-bit Windows and 64-bit OSX are supplied in the <tt>DSI_API</tt> subdirectory, and the appropriate one will be copied to prog during the build process.


	==Parameters==		==Parameters==