Welcome to etalumacontrol’s documentation!

This library provides a simplified Python interface for interacting with Etaluma microscopes and motorized stages (600 and 700 series). Essentially, the code provides a simplified wrapper for Etaluma’s own C# SDK using Python.NET. This package requires Python 3.8 (or higher, but Python.NET currently supports only up to 3.8).

Note

This library was written to facilitate our own use case, but may also be useful to others. If there’s a particular feature that you feel is lacking, feel free to submit an issue or PR on GitHub. Etalumacontrol has only been tested on our LS720, but should work on any 600 and 700 series microscope. 32-bit versions of the LumaUSB and WSC DLL’s are included, but have not been tested.

Contents

• Usage
  • Installation
  • Quickstart
• API Reference
  • etalumacontrol
    • Subpackages
      • etalumacontrol.CypressFX
        • Package Contents
          • Classes
            • FX2
              • REQ_WRITE
              • REQ_READ
              • CMD_RW_INTERNAL
              • CMD_RW_EEPROM
              • MAX_CTRL_BUFFER_LENGTH
              • with_vid_pid
              • with_bus_address
              • reset
              • __ensure_vend_ax_firmware
              • read_eeprom
              • write_eeprom
              • __send_usbctrldata
              • load_intelhex_firmware
    • Submodules
      • etalumacontrol.definitions
        • Module Contents
          • ROOT_DIR
          • RSC_DIR
          • LIB_DIR
          • LED_WHITE
      • etalumacontrol.lumascope
        • Module Contents
          • Classes
          • Attributes
            • LUMAUSB_DLL
            • CameraError
            • LumaScope
              • MAX_GLOBAL_GAIN
              • MIN_GLOBAL_GAIN
              • _shutter
              • _gain
              • __enter__
              • __exit__
              • close
              • gain
              • resolution
              • shutter
              • set_led
              • get_image
              • get_raw_image_buffer
      • etalumacontrol.stage
        • Module Contents
          • Classes
          • Attributes
            • LUMAUSB_DLL
            • StageError
            • EtalumaStage
              • __enter__
              • __exit__
              • close
              • mm_to_microsteps
              • _check_axis
              • get_pos
              • move
              • stop
    • Package Contents
      • Classes
        • LumaScope
          • MAX_GLOBAL_GAIN
          • MIN_GLOBAL_GAIN
          • _shutter
          • _gain
          • __enter__
          • __exit__
          • close
          • gain
          • resolution
          • shutter
          • set_led
          • get_image
          • get_raw_image_buffer
        • EtalumaStage
          • __enter__
          • __exit__
          • close
          • mm_to_microsteps
          • _check_axis
          • get_pos
          • move
          • stop

License

Etalumacontrol is licensed under a 2-clause BSD license.

Etalumacontrol contains microscope firmware and DLL files kindly provided by Etaluma, which are not subject to this license. These files may be distributed as part of the etalumacontrol package, but for other uses please contact Etaluma directly.

Etalumacontrol contains code written by John Kelley. See its separate license file in the CypressFX directory.

Indices and tables

• Index

• Module Index

• Search Page