- Notifications
You must be signed in to change notification settings - Fork2
openUC2/ImSwitchConfig
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This repository will help you setting up theJSON-files for the UC2-specific devices, namely:
- Allied Vision Alvium Camera / Vimba
- Daheng Imaging Machine Vision
- UC2 electronics (ESP32-based)
- XYZ Stage
- Laser
- LED
- LED Matrix
- Raspberry Pi camera (experimental)
- ESP32 camera
More information can be found in the original documentation of ImSwitch can be found in theREADTHEDOCS of IMSWITCH
The file under$USER$/Documents/ImSwitchConfig/config/modules.json (Windows) and/User/$username$/ImSwitchConfig/config/modules.json (Mac/Linux) may look like this:
{"enabled": ["imcontrol","imscripting","imnotebook" ]}These are the available modules that will be loaded on startup of imswitch. ImControl is the general control GUI, ImScripting is the python interpreter to control the system, ImNotebook launches a jupyter server that can be used to control ImSwitch inside imswitch using Jupyter.
The file under$USER$/Documents/ImSwitchConfig/config/imcontrol_options.json (Windows) and/User/$username$/ImSwitchConfig/config/imcontrol_options.json (Mac/Linux) may look like this:
{"setupFileName":"example_virtual_microscope.json","recording": {"outputFolder":"./ImSwitch/ImSwitch/recordings","includeDateInOutputFolder":true },"watcher": {"outputFolder":"/Users/bene/ImSwitchConfig/scripts" }}The entry"setupFileName": "example_virtual_microscope.json", determines the current active configuration file that defines the hardware configuration (E.g. camera, positioner.. see below). This file is stored under..imcontrol_setups.
ImSwitch will create a folder that stores all settings in:
- Windows
$USER$/Documents/ImSwitchConfig - MAC
/User/$username$/ImSwitchConfig
There you will find several subfolders:
configimcontrol_setupsimcontrol_slmscriptsYou can download this repo and replace all files in this folder. Alternatively, you can clone it and keep it up to date with upcoming configurations.
A recent sample configuration is for example theimcontrol_setups/example_uc2_multicolour.json. It controls an ESP32-driven XYZ stage, hosts 2 lasers and has a Daheng Vision camera:
{"rs232devices": {"ESP32": {"managerName":"ESP32Manager","managerProperties": {"host_":"192.168.43.129","serialport_windows":"COM3","serialport":"/dev/cu./dev/cu.SLAB_USBtoUART" } } },"positioners": {"ESP32Stage": {"managerName":"ESP32StageManager","managerProperties": {"rs232device":"ESP32" },"axes": ["X","Y","Z"],"forScanning":true,"forPositioning":true }},"lasers": {"488 Laser": {"analogChannel":null,"digitalLine":null,"managerName":"ESP32LEDLaserManager","managerProperties": {"rs232device":"ESP32","channel_index":"B","filter_change":true },"wavelength":488,"valueRangeMin":0,"valueRangeMax":32768},"635 Laser": {"analogChannel":null,"digitalLine":null,"managerName":"ESP32LEDLaserManager","managerProperties": {"rs232device":"ESP32","channel_index":"R","filter_change":true },"wavelength":635,"valueRangeMin":0,"valueRangeMax":32768},"LED": {"analogChannel":null,"digitalLine":null,"managerName":"ESP32LEDLaserManager","managerProperties": {"rs232device":"ESP32","channel_index":"W","filter_change":false },"wavelength":635,"valueRangeMin":0,"valueRangeMax":32768}},"detectors": {"WidefieldCamera": {"analogChannel":null,"digitalLine":null,"managerName":"GXPIPYManager","managerProperties": {"cameraListIndex":1,"gxipycam": {"exposure":0,"gain":0,"blacklevel":100,"image_width":1000,"image_height":1000 } },"forAcquisition":true,"forFocusLock":true }},"rois": {"Full chip": {"x":600,"y":600,"w":1200,"h":1200 }},"availableWidgets": ["Settings","View","Recording","Image","Laser","Positioner","Autofocus" ],"autofocus": {"camera":"WidefieldCamera","positioner":"ESP32Stage","updateFreq":10,"frameCropx":780,"frameCropy":400,"frameCropw":500,"frameCroph":100 }}Since multiple devices (stage, laser, filterswitcher) are connected to a single USB/Serial device (ESP32), we have to write a wrapper that connects to all individual devices. This is calledrs232devices:
"rs232devices": {"ESP32": {"managerName":"ESP32Manager","managerProperties": {"host_":"192.168.43.129","serialport_windows":"COM3","serialport":"/dev/cu./dev/cu.SLAB_USBtoUART" } } },
Theserialport specifies the correct physical address of the device and has to be adapted. Alternatively, one can specify thehost if you want to connect over Wifi.Theoretically, if everything goes right, ImSwitch is smart enough to detect the ESP32 on its own. Thhe name for this device (i.e. internal reference) isESP32 and will be reused by all external components.
Thefirmware can be foundhere.
All devices refer to thers232device defined earlier:
"positioners": {"ESP32Stage": {"managerName":"ESP32StageManager","managerProperties": {"rs232device":"ESP32" },"axes": ["X","Y","Z"],"forScanning":true,"forPositioning":true }},
This defines the x-y-z axis and will control theESP32 device.forScanning - states that the stage is used for a potential Multiwellplate scanner and`forPositioning - states that it can be used as a normal positining device.
The name635 Laser is chosen for the red laser.filter_change is an option to rotate the motor that moves the filter.Thechannel_index (e.g. R, G, B) state the different colours / channels. (TODO: perhaps this is now 1,2,3).
"635 Laser": {"analogChannel":null,"digitalLine":null,"managerName":"ESP32LEDLaserManager","managerProperties": {"rs232device":"ESP32","channel_index":"R","filter_change":true },"wavelength":635,"valueRangeMin":0,"valueRangeMax":32768},
Example for the Daheng Imaging camera:
"detectors": {"WidefieldCamera": {"analogChannel":null,"digitalLine":null,"managerName":"GXPIPYManager","managerProperties": {"cameraListIndex":1,"gxipycam": {"exposure":0,"gain":0,"blacklevel":100,"image_width":1000,"image_height":1000 } },"forAcquisition":true,"forFocusLock":true }},
More information coming soon!
If you have any questions, please file an issue :-)
About
Resources
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Contributors3
Uh oh!
There was an error while loading.Please reload this page.