HardwareDevice schemas

Type-specific details of hardware devices in the shared catalog.

Table of contents

  1. How to use this family
  2. Quick type map
  3. Data acquisition
    1. Amplifier
    2. Camera
    3. Data acquisition system
    4. Electroencephalography system (EEG)
    5. Electromyography machine
    6. Ephys rig
    7. Fiber photometry system
    8. Force plate
    9. Humidity sensor
    10. Light sensor
    11. Magnetic resonance imaging (MRI) system
    12. Magnetoencephalography (MEG) system
    13. Magnetometer
    14. Microphone
    15. Miniscope
    16. Motion tracking system
    17. Ophys rig
    18. Optical Coherence Tomography (OCT)
    19. Oscilloscope
    20. Photodetector
    21. Signal processing unit
    22. Single-photon emission computed tomography (SPECT)
    23. Temperature sensor
    24. Ultrasound imaging system
  4. Behavioral and stimulation tools
    1. Behavior rig
    2. Floating air platform
    3. Iontophoresis stimulator
    4. Laser
    5. LED driver
    6. Light emitter
    7. Running wheel
    8. Speaker
    9. Stimulation device
    10. Treadmill
  5. Environmental controllers
    1. Anti-vibration table
    2. Humidity controller
    3. Noise isolation chamber
    4. Thermal controller
  6. Surgical equipment
    1. Anesthesia system
    2. Injection system
    3. Micromanipulator
    4. Perfusion system
    5. Stereotaxic frame
    6. Surgical power tool
  7. Miscellaneous
    1. Biosafety cabinet
    2. Computer
    3. Electronic component
    4. Fume hood
    5. Glass micropipette puller
    6. Microcontroller (e.g., Arduino)
    7. Microscope
    8. Monitor
    9. Single-board computer (e.g., Raspberry Pi)
  8. External Identifiers

How to use this family

  • hardwaredevice: set type to a type code below and send its properties in type_json.
  • hardwaredeviceapproval: type selects the type; each log entry added through the entry actions is validated against it.
  • Every version is published at https://www.brainstem.org/schemas/HardwareDevice/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/HardwareDevice/<Type>.json is the current version and https://www.brainstem.org/schemas/HardwareDevice/<Type>/ lists the versions. See Public schemas.
  • Quantities are objects {"value": <number>, "unit": "<code>"}. Property paths with [] are inside a repeatable list of rows. The server sets the schema version field itself.

Quick type map

Type codeTitleGroupVersionRequired propertiesSchema
AmplifierAmplifierData acquisition1.0.0none1.0.0.json
AnesthesiaSystemAnesthesia systemSurgical equipment1.0.0none1.0.0.json
AntiVibrationTableAnti-vibration tableEnvironmental controllers1.0.0none1.0.0.json
BehaviorRigBehavior rigBehavioral and stimulation tools1.0.0none1.0.0.json
BiosafetyCabinetBiosafety cabinetMiscellaneous1.0.0none1.0.0.json
CameraCameraData acquisition1.0.0none1.0.0.json
ComputerComputerMiscellaneous1.0.0none1.0.0.json
DataAcquisitionSystemData acquisition systemData acquisition1.0.0none1.0.0.json
ElectroencephalographySystemElectroencephalography system (EEG)Data acquisition1.0.0none1.0.0.json
ElectromyographyMachineElectromyography machineData acquisition1.0.0none1.0.0.json
ElectronicComponentElectronic componentMiscellaneous1.0.0none1.0.0.json
EphysRigEphys rigData acquisition1.0.0none1.0.0.json
ExternalIdentifiersExternal Identifiers (form only) 1.0.0source, id1.0.0.json
FiberPhotometrySystemFiber photometry systemData acquisition1.0.0none1.0.0.json
FloatingAirPlatformFloating air platformBehavioral and stimulation tools1.0.0none1.0.0.json
ForcePlateForce plateData acquisition1.0.0none1.0.0.json
FumeHoodFume hoodMiscellaneous1.0.0none1.0.0.json
GlassMicropipettePullerGlass micropipette pullerMiscellaneous1.0.0none1.0.0.json
HumidityControllerHumidity controllerEnvironmental controllers1.0.0none1.0.0.json
HumiditySensorHumidity sensorData acquisition1.0.0none1.0.0.json
InjectionSystemInjection systemSurgical equipment1.0.0none1.0.0.json
IontophoresisStimulatorIontophoresis stimulatorBehavioral and stimulation tools1.0.0none1.0.0.json
LaserLaserBehavioral and stimulation tools1.0.0none1.0.0.json
LedDriverLED driverBehavioral and stimulation tools1.0.0none1.0.0.json
LightEmitterLight emitterBehavioral and stimulation tools1.0.0none1.0.0.json
LightSensorLight sensorData acquisition1.0.0none1.0.0.json
MagneticResonanceImagingSystemMagnetic resonance imaging (MRI) systemData acquisition1.0.0none1.0.0.json
MagnetoencephalographySystemMagnetoencephalography (MEG) systemData acquisition1.0.0none1.0.0.json
MagnetometerMagnetometerData acquisition1.0.0none1.0.0.json
MicrocontrollerMicrocontroller (e.g., Arduino)Miscellaneous1.0.0none1.0.0.json
MicromanipulatorMicromanipulatorSurgical equipment1.0.0none1.0.0.json
MicrophoneMicrophoneData acquisition1.0.0none1.0.0.json
MicroscopeMicroscopeMiscellaneous1.0.0none1.0.0.json
MiniscopeMiniscopeData acquisition1.0.0none1.0.0.json
MonitorMonitorMiscellaneous1.0.0none1.0.0.json
MotionTrackingSystemMotion tracking systemData acquisition1.0.0none1.0.0.json
NoiseIsolationChamberNoise isolation chamberEnvironmental controllers1.0.0none1.0.0.json
OphysRigOphys rigData acquisition1.0.0none1.0.0.json
OpticalCoherenceTomographyOptical Coherence Tomography (OCT)Data acquisition1.0.0none1.0.0.json
OscilloscopeOscilloscopeData acquisition1.0.0none1.0.0.json
PerfusionSystemPerfusion systemSurgical equipment1.0.0none1.0.0.json
PhotodetectorPhotodetectorData acquisition1.0.0none1.0.0.json
RunningWheelRunning wheelBehavioral and stimulation tools1.0.0none1.0.0.json
SignalProcessingUnitSignal processing unitData acquisition1.0.0none1.0.0.json
SingleBoardComputerSingle-board computer (e.g., Raspberry Pi)Miscellaneous1.0.0none1.0.0.json
SinglePhotonEmissionComputedTomographySingle-photon emission computed tomography (SPECT)Data acquisition1.0.0none1.0.0.json
SpeakerSpeakerBehavioral and stimulation tools1.0.0none1.0.0.json
StereotaxicFrameStereotaxic frameSurgical equipment1.0.0none1.0.0.json
StimulationDeviceStimulation deviceBehavioral and stimulation tools1.0.0none1.0.0.json
SurgicalPowerToolSurgical power toolSurgical equipment1.0.0none1.0.0.json
TemperatureSensorTemperature sensorData acquisition1.0.0none1.0.0.json
ThermalControllerThermal controllerEnvironmental controllers1.0.0none1.0.0.json
TreadmillTreadmillBehavioral and stimulation tools1.0.0none1.0.0.json
UltrasoundImagingSystemUltrasound imaging systemData acquisition1.0.0none1.0.0.json

Data acquisition

Amplifier

  • type code Amplifier · version 1.0.0 · schema

An amplifier product for electrophysiological signals, described by its nominal specifications such as channel count, gain range, bandwidth, input impedance and noise level. Individual units in a lab’s setups are documented as equipment that refers to this entry.

PropertyTitleShapeRequiredAllowed valuesMeaning
productIdProduct IDtext  A unique product identifier for the amplifier as defined by the supplier.
nChannelsNumber of Channelsnumber ≥ 1Number of input channels supported by the amplifier.
gainGain Rangetext  Amplification gain range (e.g., ‘1x - 10,000x’, ‘1000x’).
bandwidthBandwidthtext  Frequency bandwidth of the amplifier (e.g., ‘DC - 10 kHz’, ‘0.1 Hz - 7.5 kHz’).
inputImpedanceInput Impedancetext  Input impedance specification (e.g., ‘>10 GΩ’, ‘1 MΩ’).
noiseLevelNoise Leveltext  Noise level specification (e.g., ‘<3 µV RMS’, ‘2.4 µV RMS’).
powerSupplyPower Supplytext  Power supply requirements (e.g., ‘+/- 15V’, ‘5V USB’, ‘Battery’).

Illustrative payload:

{
    "productId": "text",
    "nChannels": 1.0
}

Camera

  • type code Camera · version 1.0.0 · schema

A camera product used for behavioral video or scientific imaging, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Data acquisition system

  • type code DataAcquisitionSystem · version 1.0.0 · schema

A data acquisition product, such as a DAQ board or multichannel recording system, that digitizes analog and digital signals, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Electroencephalography system (EEG)

  • type code ElectroencephalographySystem · version 1.0.0 · schema

An EEG system product for recording electrical brain activity from scalp or skull-surface electrodes, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Electromyography machine

  • type code ElectromyographyMachine · version 1.0.0 · schema

An EMG system product for recording the electrical activity of muscles, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Ephys rig

  • type code EphysRig · version 1.0.0 · schema

An integrated electrophysiology system sold as one product, such as a complete patch-clamp or extracellular recording rig, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Fiber photometry system

  • type code FiberPhotometrySystem · version 1.0.0 · schema

A fiber photometry system product that delivers excitation light through optical fibers and records fluorescence from genetically encoded indicators, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Force plate

  • type code ForcePlate · version 1.0.0 · schema

A force plate product that measures ground reaction forces, for example for gait or startle analysis, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Humidity sensor

  • type code HumiditySensor · version 1.0.0 · schema

A humidity sensor product for monitoring relative humidity in experimental or housing environments, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Light sensor

  • type code LightSensor · version 1.0.0 · schema

A light sensor product, such as an ambient light sensor or optical power meter, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Magnetic resonance imaging (MRI) system

  • type code MagneticResonanceImagingSystem · version 1.0.0 · schema

An MRI scanner model for structural or functional imaging, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Magnetoencephalography (MEG) system

  • type code MagnetoencephalographySystem · version 1.0.0 · schema

An MEG system model for recording the magnetic fields generated by neural activity, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Magnetometer

  • type code Magnetometer · version 1.0.0 · schema

A magnetometer product for measuring magnetic fields, for example for head-orientation tracking, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Microphone

  • type code Microphone · version 1.0.0 · schema

A microphone product for recording sound, including ultrasonic vocalizations, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Miniscope

  • type code Miniscope · version 1.0.0 · schema

A head-mounted miniature microscope product for imaging neural activity in freely moving animals, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Motion tracking system

  • type code MotionTrackingSystem · version 1.0.0 · schema

A motion tracking system product that records the position or posture of subjects, for example with infrared cameras and markers, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Ophys rig

  • type code OphysRig · version 1.0.0 · schema

An integrated optical physiology system sold as one product, such as a complete imaging rig, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Optical Coherence Tomography (OCT)

  • type code OpticalCoherenceTomography · version 1.0.0 · schema

An optical coherence tomography system product for depth-resolved, label-free tissue imaging, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Oscilloscope

  • type code Oscilloscope · version 1.0.0 · schema

An oscilloscope product for displaying and measuring electrical signals, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Photodetector

  • type code Photodetector · version 1.0.0 · schema

A photodetector product, such as a photodiode or photomultiplier tube, that converts light into an electrical signal, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Signal processing unit

  • type code SignalProcessingUnit · version 1.0.0 · schema

A signal processing product that filters, conditions or processes signals, for example in real time for closed-loop experiments, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Single-photon emission computed tomography (SPECT)

  • type code SinglePhotonEmissionComputedTomography · version 1.0.0 · schema

A SPECT scanner model for imaging the distribution of gamma-emitting radiotracers, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Temperature sensor

  • type code TemperatureSensor · version 1.0.0 · schema

A temperature sensor product for measuring body, bath or enclosure temperature, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Ultrasound imaging system

  • type code UltrasoundImagingSystem · version 1.0.0 · schema

An ultrasound imaging system product, used for example for functional ultrasound or anatomical imaging, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Behavioral and stimulation tools

Behavior rig

  • type code BehaviorRig · version 1.0.0 · schema

An integrated behavioral apparatus sold as one product, such as an operant chamber or commercial task system, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Floating air platform

  • type code FloatingAirPlatform · version 1.0.0 · schema

An air-lifted platform or homecage product that floats on a cushion of air for locomotion under head fixation, with its nominal specifications and supplier. Vibration isolation tables are Anti-vibration tables.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Iontophoresis stimulator

  • type code IontophoresisStimulator · version 1.0.0 · schema

An iontophoresis current source product for applying drugs or tracers through micropipettes, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Laser

  • type code Laser · version 1.0.0 · schema

A laser product used for optogenetic stimulation, photostimulation or imaging, with its nominal specifications, such as wavelength and output power, and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

LED driver

  • type code LedDriver · version 1.0.0 · schema

An LED driver product that powers and modulates LEDs, for example for optogenetic light delivery, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Light emitter

  • type code LightEmitter · version 1.0.0 · schema

An LED or other non-laser light source product used for optogenetic stimulation, visual stimulation or illumination, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Running wheel

  • type code RunningWheel · version 1.0.0 · schema

A running wheel product on which subjects run, often with an encoder for measuring locomotion, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Speaker

  • type code Speaker · version 1.0.0 · schema

A speaker product for delivering auditory stimuli, including ultrasonic sounds, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Stimulation device

  • type code StimulationDevice · version 1.0.0 · schema

A stimulator product, such as an electrical stimulus generator or stimulus isolator, with its nominal specifications and supplier. Use it for stimulation hardware that no more specific hardware type describes.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Treadmill

  • type code Treadmill · version 1.0.0 · schema

A treadmill product, motorized or freely driven, on which subjects walk or run, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Environmental controllers

Anti-vibration table

  • type code AntiVibrationTable · version 1.0.0 · schema

An anti-vibration or optical table product used to isolate setups from floor vibrations, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Humidity controller

  • type code HumidityController · version 1.0.0 · schema

A humidity controller product for regulating humidity in housing areas, setups or enclosures, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Noise isolation chamber

  • type code NoiseIsolationChamber · version 1.0.0 · schema

A sound-attenuating chamber product that shields setups from external acoustic noise, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Thermal controller

  • type code ThermalController · version 1.0.0 · schema

A temperature controller product, such as a feedback-controlled heating pad or bath heater, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Surgical equipment

Anesthesia system

  • type code AnesthesiaSystem · version 1.0.0 · schema

An anesthesia system product, such as an isoflurane vaporizer or complete inhalation anesthesia station, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Injection system

  • type code InjectionSystem · version 1.0.0 · schema

An injection system product, such as a nanoliter injector or microsyringe pump, for delivering viral vectors, tracers or drugs into tissue, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Micromanipulator

  • type code Micromanipulator · version 1.0.0 · schema

A micromanipulator product for positioning electrodes, pipettes or optical fibers with micrometer precision, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Perfusion system

  • type code PerfusionSystem · version 1.0.0 · schema

A perfusion system product for transcardial perfusion or superfusion of tissue preparations, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Stereotaxic frame

  • type code StereotaxicFrame · version 1.0.0 · schema

A stereotaxic frame product that holds the subject’s head in a fixed coordinate system for targeting brain regions, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Surgical power tool

  • type code SurgicalPowerTool · version 1.0.0 · schema

A powered surgical tool product, such as a dental drill used for craniotomies, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Miscellaneous

Biosafety cabinet

  • type code BiosafetyCabinet · version 1.0.0 · schema

A biosafety cabinet product for handling viral vectors, cell cultures and other biological materials, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Computer

  • type code Computer · version 1.0.0 · schema

A computer model used to run acquisition, stimulus-control or analysis software, with its nominal specifications and supplier. Single-board computers and microcontrollers have their own types.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Electronic component

  • type code ElectronicComponent · version 1.0.0 · schema

An electronic part or module, such as a connector, relay, filter or circuit board, with its nominal specifications and supplier. Use it for electronics that no more specific hardware type describes.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Fume hood

  • type code FumeHood · version 1.0.0 · schema

A fume hood product for working with volatile chemicals such as fixatives and solvents, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Glass micropipette puller

  • type code GlassMicropipettePuller · version 1.0.0 · schema

A micropipette puller product for fabricating glass pipettes for patch clamp, sharp-electrode recording or microinjection, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Microcontroller (e.g., Arduino)

  • type code Microcontroller · version 1.0.0 · schema

A microcontroller board, such as an Arduino model, used for task control, triggering or sensor readout, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Microscope

  • type code Microscope · version 1.0.0 · schema

A microscope product, such as a widefield, confocal, two-photon or dissection microscope, with its nominal specifications and supplier. Head-mounted miniature microscopes have their own type.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Monitor

  • type code Monitor · version 1.0.0 · schema

A display product used for presenting visual stimuli or operating acquisition software, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Single-board computer (e.g., Raspberry Pi)

  • type code SingleBoardComputer · version 1.0.0 · schema

A single-board computer model, such as a Raspberry Pi, with its nominal specifications and supplier.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

External Identifiers

  • type code ExternalIdentifiers · version 1.0.0 · schema

Add external identifiers from databases like NCBI, JAX, DOI, etc. Include URLs when available.

PropertyTitleShapeRequiredAllowed valuesMeaning
sourceSourcechoiceyesone of DOI, PubMed, Manufacturer, Model Number, Serial Number, Custom, Other; default "Manufacturer" 
idIdentifiertextyes  
urlURL (optional)text   

Illustrative payload:

[
    {
        "source": "DOI",
        "id": "text",
        "url": "text"
    }
]