json-schemas.rig

Download Schema

BciNoMovementRig

type	object
properties
describedBy	Describedby
	type	string
schema_version	Version
	schema version
	type	string
	pattern	^\d+.\d+.\d+$
computer_name	Computer Name
	Computer name
	type	string
rig_name	Rig Name
	Rig name
	type	string
harp_behavior	Harp behavior
	allOf	HarpBehavior
harp_load_cell	Harp load cells
	allOf	HarpLoadCells
harp_clock	Harp clock synchronizer
	allOf	HarpClockSynchronizer
camera_0	Required spinnaker camera
	allOf	SpinnakerCamera
camera_1	Optional spinnaker camera
	default	null
	oneOf	SpinnakerCamera
		type	null
zaber_manipulator	Zaber manipulator
	allOf	ZaberManipulator
networking	default	zmq_publisher	connection_string	@tcp://localhost:5556
			topic	bci-no-movement
		zmq_subscriber	connection_string	@tcp://localhost:5557
			topic	bci-no-movement
	allOf	Networking
operation	default	load_cell_offset	0
			0
			0
			0
			0
			0
			0
			0
		load_cell_index	0
	allOf	Operation
additionalProperties	False

Axis

type	integer
enum	1, 2, 3, 0

HarpBehavior

type	object
properties
who_am_i	Who Am I
	type	integer
	default	1216
	const	1216
device_type	Device Type
	type	string
	default	behavior
	const	behavior
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string
additional_settings	Additional Settings
	Additional settings
	default	null
	oneOf	type	null
additionalProperties	False

HarpClockSynchronizer

type	object
properties
who_am_i	Who Am I
	type	integer
	default	1152
	const	1152
device_type	Device Type
	type	string
	default	clocksynchronizer
	const	clocksynchronizer
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string
additional_settings	Additional Settings
	Additional settings
	default	null
	oneOf	type	null
additionalProperties	False

HarpLoadCells

type	object
properties
who_am_i	Who Am I
	type	integer
	default	1232
	const	1232
device_type	Device Type
	type	string
	default	loadcells
	const	loadcells
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string
additional_settings	Additional Settings
	Additional settings
	default	null
	oneOf	type	null
additionalProperties	False

Networking

type	object
properties
zmq_publisher	default	connection_string	@tcp://localhost:5556
		topic	bci-no-movement
	allOf	ZmqConnection
zmq_subscriber	default	connection_string	@tcp://localhost:5557
		topic	bci-no-movement
	allOf	ZmqConnection
additionalProperties	False

Operation

type	object
properties
load_cell_offset	Load Cell Offset
	Bias offset of a specific loadcell channel.
	type	array
	default	0
		0
		0
		0
		0
		0
		0
		0
	items	type	integer
	maxItems	8
	minItems	8
load_cell_index	Load Cell Index
	Index of the loadcell channel to use.
	type	integer
	maximum	7
	minimum	0
	default	0
additionalProperties	False

SpinnakerCamera

type	object
properties
serial_number	Serial Number
	Camera serial number
	type	string
binning	Binning
	Binning
	type	integer
	minimum	1
	default	1
color_processing	Color Processing
	Color processing
	type	string
	enum	Default, NoColorProcessing
	default	Default
exposure	Exposure
	Exposure time
	type	integer
	minimum	100
	default	1000
frame_rate	Frame Rate
	Frame rate
	type	integer
	maximum	350
	minimum	1
	default	30
gain	Gain
	Gain
	type	number
	minimum	0.0
	default	0
additionalProperties	False

ZaberAxis

type	object
properties
device_index	Device Index
	Device number.
	type	integer
	minimum	0
axis_index	Axis Index
	Motor to send the instruction to.
	type	integer
	minimum	0
additionalProperties	False

ZaberGenericCommand

type	object
properties
command	Command
	type	string
axis	Axis
	Motor to send the instruction to.
	type	integer
	default	0
device	Device
	Device number.
	type	integer
	minimum	0
	default	null
additionalProperties	False

ZaberManipulator

type	object
properties
com_port	Com Port
	COM port of the manipulator.
	type	string
	default	COM1
generic_commands	Generic Commands
	List of generic commands to send to the manipulator.
	type	array
	default
	items	ZaberGenericCommand
spout_axis	Axis of the spout.
	default	1
	allOf	Axis
velocity	Velocity
	Maximum speed of the manipulator.
	type	number
	minimum	0.0
	default	10
acceleration	Acceleration
	Acceleration of the manipulator.
	type	number
	minimum	0.0
	default	1299.63
x_axis	X-axis mapping.
	allOf	ZaberAxis
y_axis	Y-axis mapping.
	allOf	ZaberAxis
z_axis	Z-axis mapping.
	allOf	ZaberAxis
additionalProperties	False

ZmqConnection

type	object
properties
connection_string	Connection String
	type	string
	default	@tcp://localhost:5556
topic	Topic
	type	string
	default
additionalProperties	False