rig.json discussion

[alexpiet]

• We will add a template for the rig.json that will live in the src/settings_templates/rig.json
  • This template will have information for FIP, Opto, and behavior.
• When we configure each behavior box, we will need to edit the rig.json, and then move it to ForagingSettings
  • The user will need to add/remove the relevant modalities (FIP, Opto)
  • There will be a rig.json for each behavior box, so we can name them rig_box1.json, etc
• The specific fields that will need to be modified for all behavior boxes:
  • modification_date
  • cameras/camera assembly/computer_name (if there are multiple cameras, need to change in multiple places)
  • cameras/camera_assembly/lens/serial_number (if available)
  • daqs/HarpDevice/computer_name
• The specific fields that will need to be modified for FIB rigs:
  • modalities (add Modality.FIB )
  • detectors/Detector/serial_number (these are CMOS FIB cameras, will be two Green/Red)
  • objectives/Objective/serial_number
• The specific fields that will need to be modified for Opto rigs:
  • ??
• The specific fields that need to be modified on Ephys rigs:
  • Lick detectors are AINDLickDetector, not Janelia_Lick_Detector
  • Cameras, hardware/drivers
• As part of the FIB excitation LED calibration, the rig.json needs to be updated
  • [ ] Make a note in the SOP for the FIB laser calibration (@hagikent)
• [ ] Add opto device information (@XX-Yin) to KH's draft
  • NiDAQ hardware/driver
  • LED/laser?
• [x] Add Harp driver (@hagikent )
  • https://ftdichip.com/drivers/
  • "FTDI driver (for Harp devices)"
  • "Install the version marked: "Click here to download the Windows 7 to Windows 11 and Windows Server driver installer"
• [x] Add newscale lick stages (@hagikent)
  • [x] travel, should be distance the newscale stage can move
  • [x] travel_unit
  • [x] serial number for newscale stage (can grab from ForagingSettings.json)
  • [x] firmware, github repo/branch/commit
    • https://github.com/AllenNeuralDynamics/python-newscale, branch: axes-on-target, commit #7c17497
  • [x] USBXpress driver (https://www.silabs.com/documents/public/software/install_USBXpress_SDK.exe)
• [x] Update Computer configuration instructions based on this rig.json (@alexpiet )
• [x] Update GUI code (@alexpiet)
  • [x] The GUI will either (1) load the existing rig.json saved in ForagingSettings, or (2) generate a new rig.json
  • [x] The rig.json will need to be regenerated if we perform calibration on the laser, FIB, or water; if any part with a serial number changes.
  • [x] The GUI can check these things by loading the existing json, checking against the calibration files/task files.
  • [ ] After getting a valid rig.json it will be copied to the metadata directory of the saved data folder

TODO after PR #447

• [x] Need to pin version of aind-data-schema
• [ ] fill in what details are specified in the rig_specification file
• [x] add instructions for how/when rig_specification_<box_number>.json should be updated
• [x] Determine what data modalities are included (video? Opto?)
• [x] Camera entries are fixed, unclear if they are for 428 or 447 @hagikent
• [x] AIND lick spout motor stage details are missing
• [x] Speaker details are missing
• [x] Laser calibrations are missing - unclear if its for opto or FIP
• [x] FIP entries are fixed, and dont load from rig_specification
• [x] Harp devices are missing, including sound card, expander, synchronization board, etc
• [x] Optogenetic details are missing

[alexpiet]

I was working on the GUI updates here (https://github.com/AllenNeuralDynamics/dynamic-foraging-task/tree/fix_345)

But @hagikent and I realized we probably need to run his script inside the GUI to validate the rig json when we change it, instead of manually editing the json files

[alexpiet]

Closing this issue with #447