Skip to main content

ImSwitch Usage Tutorials

This section covers how to use ImSwitch effectively, from basic operations to advanced workflows.

Getting Started

  1. Basic Usage - First steps with ImSwitch

    • Interface overview
    • Basic controls
    • Camera and stage operation
  2. UC2-REST Integration - Python interface for UC2-ESP32

    • Setting up UC2-REST
    • Communication with ESP32 firmware
    • Hardware control examples
  3. Micromanager Integration - Using ImSwitch with µManager

    • Device adapter setup
    • Integration with µManager workflows
    • Advanced microscopy protocols

Key Features

Hardware Control

  • Camera Control: Live imaging, exposure, gain settings
  • Stage Movement: XYZ positioning, scanning protocols
  • Illumination: LED arrays, lasers, intensity control
  • Automated Workflows: Time-lapse, multi-position imaging

Software Integration

  • UC2-REST: Python interface for ESP32 communication
  • Micromanager: Industry-standard microscopy software
  • Napari: Advanced image processing and analysis
  • Jupyter Notebooks: Interactive analysis workflows

Remote Access

  • Web Interface: Browser-based control via REST API
  • SSH Access: Command-line interface for advanced users
  • API Integration: Custom software integration

Quick Reference

Essential Commands

# Basic ImSwitch startup
python -m imswitch

# With specific configuration
python -m imswitch --config my_config.json

# UC2-REST communication
from UC2REST import UC2Client
client = UC2Client(serialport="/dev/ttyUSB0")

Configuration Files

  • Main config: ImSwitchConfig/config/imcontrol_options.json
  • Hardware setup: ImSwitchConfig/imcontrol_setups/your_setup.json
  • Scripts: ImSwitchConfig/scripts/

Support

  • Troubleshooting: Each tutorial includes troubleshooting sections
  • Examples: Practical examples with real hardware
  • Updates: Update procedures for keeping software current