microscope-cockpit / cockpit

Cockpit is a microscope graphical user interface. It is a flexible and easy to extend platform aimed at life scientists using bespoke microscopes.
https://microscope-cockpit.org
GNU General Public License v3.0
35 stars 26 forks source link

Device specific depot config options. #803

Closed iandobbie closed 1 year ago

iandobbie commented 2 years ago

Revealed by my recent attempt to complete the multi-channel experiments on one camera (#686) and Julio's reversing Z stack orientation (#785) questions there is basically no documentation on any device specific config options in the depot config section. A few things that need to be addressed:

General description of params, URI, type, trigger source, trigger line, analog line

Device specific config options: stages: gains and offsets for analog, units per um for serial connections cameras: filter wheels, multi channel experiment support filter wheels: assignment of wavelength, labels, settle times

I'm sure there are plenty of others.

iandobbie commented 2 years ago

I have added the above info plus quite a bit more. Need to merge the multi channel and the digital Z stack branches and add the relevant documentation as well.

One issue is I have not done the spec for the ND filter wheel as I dont have an example and never used it in anger. We should check exactly what spec it is meant to have.

iandobbie commented 2 years ago

i have written a summary of how to connect a Red Pitaya up to use as a timing source. I will add this with a bit of editing but we should also add some info about setting up a private network for communicating between machines.

iandobbie commented 1 year ago

The core current devices are documented. The point about needing to merge the digital Z stack and multi channel on one camera is still true. However these both have their own issues so I am closing this issue.

carandraug commented 1 year ago

For reference, they are currently documented at https://microscope-cockpit.org/depot-config.html