json-schema

The following json-schemas are used as the format definition of the input for this task. They are the result of the Pydantic` models defined in src/aind_behavior_telekinesis, and are also used to generate src/Extensions/AindBehaviorTelekinesis.cs via Bonsai.Sgen.

Download Schema

Task Logic Schema

AindBehaviorTelekinesisTaskLogic

Task logic definition for the Telekinesis behavior task
type	object
properties
name	Name
	Name of the task logic
	type	string
	default	AindTelekinesis
	const	AindTelekinesis
description	Description
	Description of the task.
	type	string
	default
task_parameters	Parameters of the task logic
	#/$defs/AindTelekinesisTaskParameters
version	Version
	type	string
	default	0.5.0-rc2
	const	0.5.0-rc2
stage_name	Stage Name
	Optional stage name the Task object instance represents.
	default	null
	oneOf	type	string
		type	null
additionalProperties	False

Rig Schema

AindBehaviorTelekinesisRig

type	object
properties
aind_behavior_services_pkg_version	aind_behavior_services package version
	type	string
	pattern	^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
	default	0.13.6
version	Version
	type	string
	default	0.5.0-rc2
	const	0.5.0-rc2
computer_name	Computer Name
	Computer name
	type	string
rig_name	Rig Name
	Rig name
	type	string
data_directory	Data Directory
	Directory where data will be saved to
	type	string
	format	path
triggered_camera_controller	Required camera controller to triggered cameras.
	#/$defs/CameraController_SpinnakerCamera_
harp_behavior	Harp behavior
	#/$defs/HarpBehavior
harp_lickometer	Harp lickometer
	#/$defs/HarpLicketySplit
harp_load_cells	Harp load cells
	default	null
	oneOf	#/$defs/LoadCells
		type	null
harp_clock_generator	Harp clock generator
	#/$defs/HarpWhiteRabbit
harp_analog_input	Harp analog input
	default	null
	oneOf	#/$defs/HarpAnalogInput
		type	null
harp_environment_sensor	Harp environment sensor
	default	null
	oneOf	#/$defs/HarpEnvironmentSensor
		type	null
manipulator	Manipulator
	#/$defs/AindManipulatorDevice
calibration	General rig calibration
	#/$defs/RigCalibration
networking	Networking settings
	default	zmq_publisher	connection_string	@tcp://localhost:5556
			topic	telekinesis
	#/$defs/Networking
ophys_interface	Ophys interface
	default	interface	bergamo
		delay_trial	0.0
	oneOf	#/$defs/OphysInterface
		type	null