OpenFlexure Microscope Server API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Module Index

  • openflexure_microscope_server - The OpenFlexure Microscope Server Package.
    • background_detect - Provide functionality to detect if the camera is imaging sample or background.
    • logging - Configure logging for the OpenFlexure Server.
    • scan_directories - Functionality to manage file system operations for scan directories.
    • scan_planners - Functionality for planning scan routes.
    • server - A package responsible for, setup, booting, and shutting down the server.
      • legacy_api - Provide endpoints that mimic the v2 API for OpenFlexure Connect discoverability.
      • serve_static_files - Add endpoints for static files to the underlying FastAPI server.
    • stitching - Communicate with OpenFlexure Stitching to perform stitches for scans.
    • things - A package for all of the core LabThings-FastAPI Things shipped with the microscope.
      • autofocus - OpenFlexure Microscope autofocus module.
      • camera - OpenFlexure Microscope Camera.
        • opencv - OpenFlexure Microscope OpenCV Camera.
        • picamera - Submodule for interacting with a Raspberry Pi camera using the Picamera2 library.
        • picamera_recalibrate_utils - Functions to set up a Raspberry Pi Camera v2 for scientific use.
        • simulation - OpenFlexure Microscope OpenCV Camera.
      • camera_stage_mapping - OpenFlexure Microscope API extension for stage calibration.
      • smart_scan - The core sample scanning functionality for the OpenFlexure Microscope.
      • stage - A package for stage control Things.
        • dummy - Functionality for mimicking a stage during simulation and testing.
        • sangaboard - Provide a LabThings-FastAPI interface to the Sangaboard motor controller.
      • system - OpenFlexure System.
    • ui - Functionality for communicating the required user interface for a thing.
    • utilities - Utility functions and classes.

API Documentation for OpenFlexure Microscope Server, generated by pydoctor 25.4.0 at 2025-08-22 13:33:59.