User Reference:JSON Parameter Format - Revision history

Mellinger: /* Synopsis */

2026-10-12T16:34:11Z

Synopsis

← Older revision		Revision as of 16:34, 12 October 2026
Line 1:		Line 1:
	==Synopsis==		==Synopsis==
	The BCI2000 JSON parameter format defines how [[Technical Reference:Parameter Definition\|BCI2000 parameters]] are represented when using JSON related parameter functions in the [[Programming Reference:BCI2000Remote Class]], the [[Technical Reference:Operator Library]], or [[User Reference:Operator Module Scripting]].		The BCI2000 JSON parameter format defines how [[Technical Reference:Parameter Definition\|BCI2000 parameters]] are represented when using JSON related parameter functions in the [[Programming Reference:BCI2000Remote Class\|BCI2000Remote Class]], the [[Technical Reference:Operator Library\|Operator Library]], or [[User Reference:Operator Module Scripting\|Operator Module Scripting]].

	Due to the fact that a Python ''dict'' object may easily be represented in JSON format, the JSON parameter format is most useful when used with Python.		Due to the fact that a Python ''dict'' object may easily be represented in JSON format, the JSON parameter format is most useful when used with Python.

Mellinger: /* Example */

2026-10-12T16:33:32Z

Example

← Older revision		Revision as of 16:33, 12 October 2026
Line 45:		Line 45:

	==Example==		==Example==
	The following is an example in Python, using the [[Programming Reference:BCI2000Remote Class]].		The following is an example in Python, using the [[Programming Reference:BCI2000Remote Class\|BCI2000Remote Class]].

	import json		import json

Mellinger: /* See also */

2026-10-12T16:32:33Z

Mellinger: /* Example */

2026-10-12T16:30:59Z

Example

← Older revision		Revision as of 16:30, 12 October 2026
Line 48:		Line 48:

	import json		import json

	bci = BCI2000Remote()		bci = BCI2000Remote()
	print("Operator path: " + bci.OperatorPath)		print("Operator path: " + bci.OperatorPath)
	bci.WindowVisible = True		bci.WindowVisible = True
	bci.WindowTitle = "Python controlled"		bci.WindowTitle = "Python controlled"

	bci.SubjectID = "pysub"		bci.SubjectID = "pysub"
	bci.Connect()		bci.Connect()

	myparam = dict()		myparam = dict()
	myparam["Name"] = 'foo'		myparam["Name"] = 'foo'
Line 64:		Line 64:
	myparam["Comment"] = 'This is a test parameter created from Python.'		myparam["Comment"] = 'This is a test parameter created from Python.'
	bci.AddParameterJson(json.dumps(myparam))		bci.AddParameterJson(json.dumps(myparam))

	myparam2 = json.loads(bci.GetParameterJson('foo'))		myparam2 = json.loads(bci.GetParameterJson('foo'))
	print(myparam2)		print(myparam2)

Mellinger: /* Example */

2026-10-12T16:30:25Z

Example

← Older revision		Revision as of 16:30, 12 October 2026
Line 67:		Line 67:
	myparam2 = json.loads(bci.GetParameterJson('foo'))		myparam2 = json.loads(bci.GetParameterJson('foo'))
	print(myparam2)		print(myparam2)

			==See also==
			[[Technical Reference:Parameter Definition]],
			[[Programming Reference:BCI2000Remote Class]],
			[[Technical Reference:Operator Library]],
			[[User Reference:Operator Module Scripting]]

Mellinger at 16:28, 12 October 2026

2026-10-12T16:28:49Z

← Older revision		Revision as of 16:28, 12 October 2026
Line 37:		Line 37:

	The ''Comment'' property may also contain additional information about a parameter; see [[Technical Reference:Parameter Definition]] for details.		The ''Comment'' property may also contain additional information about a parameter; see [[Technical Reference:Parameter Definition]] for details.

			===DefaultValue===
			An example value that may be provided to show how a parameter may be used. This is typically omitted.

			===LowRange, HighRange===
			Values that represent a numerical parameter's minimum and maximum values. In the context of JSON parameters, these are typically unused and thus omitted.

			==Example==
			The following is an example in Python, using the [[Programming Reference:BCI2000Remote Class]].

			import json

			bci = BCI2000Remote()
			print("Operator path: " + bci.OperatorPath)
			bci.WindowVisible = True
			bci.WindowTitle = "Python controlled"

			bci.SubjectID = "pysub"
			bci.Connect()

			myparam = dict()
			myparam["Name"] = 'foo'
			myparam["Sections"] = ['blubb', 'blobb']
			myparam["Type"] = 'string'
			myparam["Values"] = ['bar']
			myparam["Comment"] = 'This is a test parameter created from Python.'
			bci.AddParameterJson(json.dumps(myparam))

			myparam2 = json.loads(bci.GetParameterJson('foo'))
			print(myparam2)

Mellinger: /* RowLabels, ColumnLabels */

2026-10-12T16:23:17Z

RowLabels, ColumnLabels

← Older revision		Revision as of 16:23, 12 October 2026
Line 32:		Line 32:

	If no textual labels are available for rows and columns, specify a string-valued list from "1" to the number of entries in each property (a so-called trivial label).		If no textual labels are available for rows and columns, specify a string-valued list from "1" to the number of entries in each property (a so-called trivial label).

			===Comment===
			An arbitrary text describing the parameter to the user. This is displayed in the Operator module's parameter editor, next to the parameter value.

			The ''Comment'' property may also contain additional information about a parameter; see [[Technical Reference:Parameter Definition]] for details.

Mellinger: /* Values */

2026-10-12T16:20:22Z

Values

← Older revision		Revision as of 16:20, 12 October 2026
Line 19:		Line 19:

	===Values===		===Values===
	An array of parameter values.		An array of parameter values. For matrix valued parameters, this array is counted first by row index, and then by column index, i.e. neighboring row indices correspond to neighboring indices in the ''Values'' array.

	When ''RowLabels'' and ''ColumnLabels'' are given, the size of the ''Values'' array must be consistent with the sizes of the ''RowLabels'' and ''ColumnLabels'' arrays, i.e. the number of ''Values'' must equal the product of the numbers of ''RowLabels'' and ''ColumnLabels''.		When ''RowLabels'' and ''ColumnLabels'' are given, the size of the ''Values'' array must be consistent with the sizes of the ''RowLabels'' and ''ColumnLabels'' arrays, i.e. the number of ''Values'' must equal the product of the numbers of ''RowLabels'' and ''ColumnLabels''.
Line 26:		Line 26:

	Otherwise, reading the parameter from the JSON string will fail.		Otherwise, reading the parameter from the JSON string will fail.

			===RowLabels, ColumnLabels===
			Arrays of row resp. column labels. For single-valued and list parameters, you may omit ''RowLabels'' and ''ColumnLabels'' as described under ''Values''.
			For matrix parameters, the shape of the matrix is derived from the number of entries in row and column labels.

			If no textual labels are available for rows and columns, specify a string-valued list from "1" to the number of entries in each property (a so-called trivial label).

Mellinger at 16:14, 12 October 2026

2026-10-12T16:14:32Z

← Older revision		Revision as of 16:14, 12 October 2026
Line 1:		Line 1:
	==Synopsis==		==Synopsis==
	The BCI2000 JSON parameter format defines how [[Technical Reference:Parameter Definition\|BCI2000 parameters]] are represented when using JSON related parameter functions in the [[Programming Reference:BCI2000Remote Class]], the [[Technical Reference:Operator Library]], or [[User Reference:Operator Module Scripting]].		The BCI2000 JSON parameter format defines how [[Technical Reference:Parameter Definition\|BCI2000 parameters]] are represented when using JSON related parameter functions in the [[Programming Reference:BCI2000Remote Class]], the [[Technical Reference:Operator Library]], or [[User Reference:Operator Module Scripting]].

			Due to the fact that a Python ''dict'' object may easily be represented in JSON format, the JSON parameter format is most useful when used with Python.

			This allows creating a ''dict'' object with the desired parameter properties, and then converting it to JSON representation using the <tt>json.dumps()</tt> function. Similarly, a JSON string may be converted to a Python ''dict'' object using the <tt>json.loads()</tt> function (see example below).

			==Properties==
			The following properties are used when reading a JSON string into a parameter object. Any other properties are ignored. The only mandatory properties are "Name" and "Values". If the parameter is supposed to appear in the Operator module's parameter editor dialog, the "Section" property must be provided as well.

			===Name===
			The parameter name, with an optional path, separated by slashes ("/"). The path does not refer to the filesystem but to the internal hierarchy of filters in the BCI2000 system. Typically, you will only provide a name here, or use a path obtained from one of the <tt>GetParameterJson()</tt> call.

			===Type===
			The parameter's type, which may indicate data type, such as ''string'', ''float'', ''int'', and shape, such as ''list'' or ''matrix''. Data type is not enforced, and may be omitted for ''list'' or ''matrix'' parameters.

			===Sections===
			An array of strings which describe a hierarchy of sections, with the first one indicating the tab in the Operator module's parameter editor dialog, and the second one indicating the group box inside the tab. Any number of sections may be given but only the first two will be used in the current implementation of BCI2000.

			===Values===
			An array of parameter values.

			When ''RowLabels'' and ''ColumnLabels'' are given, the size of the ''Values'' array must be consistent with the sizes of the ''RowLabels'' and ''ColumnLabels'' arrays, i.e. the number of ''Values'' must equal the product of the numbers of ''RowLabels'' and ''ColumnLabels''.

			If neither ''RowLabels'' nor ''ColumnLabels'' are given, ''ColumnLabels'' will be set to a single "1" entry, and ''RowLabels'' will be set to a list from "1" to the number of entries in the ''Values'' array.

			Otherwise, reading the parameter from the JSON string will fail.

Mellinger: Created page with "==Synopsis== The BCI2000 JSON parameter format defines how BCI2000 parameters are represented when using JSON related parameter functions in the Programming Reference:BCI2000Remote Class, the Technical Reference:Operator Library, or User Reference:Operator Module Scripting."

2026-10-12T15:46:00Z

Created page with "==Synopsis== The BCI2000 JSON parameter format defines how BCI2000 parameters are represented when using JSON related parameter functions in the Programming Reference:BCI2000Remote Class, the Technical Reference:Operator Library, or User Reference:Operator Module Scripting."

New page

==Synopsis==
The BCI2000 JSON parameter format defines how [[Technical Reference:Parameter Definition|BCI2000 parameters]] are represented when using JSON related parameter functions in the [[Programming Reference:BCI2000Remote Class]], the [[Technical Reference:Operator Library]], or [[User Reference:Operator Module Scripting]].

← Older revision		Revision as of 16:32, 12 October 2026
Line 73:		Line 73:
	[[Technical Reference:Operator Library]],		[[Technical Reference:Operator Library]],
	[[User Reference:Operator Module Scripting]]		[[User Reference:Operator Module Scripting]]

			[[Category:Specification]]