Skip to main content

ImSwitch Advanced Documentation

This section provides comprehensive guides for ImSwitch beyond the basic Quickstart Guide.

🎯 Quick Navigation​

Essential for All Users​

Advanced Users & Developers​

📋 What Do I Need?​

Just Starting with ImSwitch?​

→ Begin with Installation then Usage

Setting up Hardware?​

→ Check Configuration and Device-Specific

Need Specific Camera Drivers?​

→ Go to Device-Specific → Daheng Camera

Want Remote Control?​

→ See Device-Specific → ImSwitch Client

Building Custom Workflows?​

→ Explore Tutorials for Jupyter notebooks and advanced integrations

Deploying on Raspberry Pi?​

→ Check Applications → WiFi Access Point

Contributing to Development?​

→ See Experimental for development tools and bleeding-edge features

📚 Section Overview​

1. Installation​

Complete installation guides for all platforms:

  • Docker (Recommended) - One-command setup with persistent data
  • Native - Python installation for Windows, macOS, Linux
  • ForkLift - Pre-configured OS image for immediate use

2. Usage​

Essential usage tutorials:

  • UC2-REST - Python interface for hardware control
  • Micromanager - µManager integration and workflows
  • Updates - Keeping your system current

3. Configuration​

System configuration documentation:

  • JSON configuration files
  • Hardware setup examples
  • Device manager configuration
  • Integration settings

4. Tutorials​

Advanced integration tutorials:

  • Image Processing - Napari integration and analysis pipelines
  • Jupyter Workflows - Interactive microscopy notebooks
  • UC2-ESP Getting Started - ESP32 firmware tutorial
  • UC2-REST Getting Started - Python interface deep dive

5. Device-Specific​

Hardware-specific guides:

  • Daheng Camera - Driver installation and setup
  • ImSwitch Client - REST API Python wrapper
  • Additional device drivers and interfaces

6. Experimental​

⚠️ Development & Testing Only:

  • Headless Mode - GUI-less operation for resource-constrained devices
  • Auto-Generated Tutorials - Developer documentation
  • Bleeding-edge features under development

7. Applications​

Specialized deployments:

  • WiFi Access Point - Raspberry Pi network setup
  • Field deployment configurations
  • Mobile microscopy setups

🚀 Recommended Learning Path​

Beginners​

  1. Docker Installation
  2. Basic Usage
  3. Configuration

Intermediate Users​

  1. Native Installation
  2. UC2-REST Interface
  3. Device Configuration

Advanced Users​

  1. Custom Workflows
  2. Image Processing
  3. Specialized Applications

Developers​

  1. Experimental Features
  2. UC2-ESP Development
  3. Custom Device Integration

💡 Tips for Success​

  • Start with Docker for the easiest setup experience
  • Read the configuration guides before connecting hardware
  • Use the Quickstart first to verify basic functionality
  • Check device-specific guides for your camera/hardware
  • Try Jupyter workflows for interactive analysis

🔗 Related Documentation​