diff --git a/docs/03_Investigator/02_FRAME/00_Cover_Page.md b/docs/03_Investigator/02_FRAME/00_Cover_Page.md index 716f8e45a..fbd1a238e 100644 --- a/docs/03_Investigator/02_FRAME/00_Cover_Page.md +++ b/docs/03_Investigator/02_FRAME/00_Cover_Page.md @@ -41,8 +41,7 @@ This product complies with the following European Directives and Standards: - **IEC 61010-1** (Safety requirements for electrical equipment) - **EN 55011** (Electromagnetic compatibility) -The CE marking indicates conformity with applicable regulations. - +**The CE marking indicates conformity with applicable regulations.** --- ## Important Safety Notice @@ -79,7 +78,7 @@ This manual is provided for the operation of the FRAME Microscope system. No par Hans-Knöll-Str. 6 07745 Jena, Germany -**Technical Support**: hello@openuc2.com (openuc2.discourse.group) +**Technical Support**: support@openuc2.com (openuc2.discourse.group) **Sales Information**: sales@openuc2.com **General Information**: hello@openuc2.com **Wiki**: https://openuc2.github.io diff --git a/docs/03_Investigator/02_FRAME/01_Safety_and_Compliance.md b/docs/03_Investigator/02_FRAME/01_Safety_and_Compliance.md index ecde1ca76..999ceecc9 100644 --- a/docs/03_Investigator/02_FRAME/01_Safety_and_Compliance.md +++ b/docs/03_Investigator/02_FRAME/01_Safety_and_Compliance.md @@ -60,9 +60,8 @@ This symbol warns of electrical hazards. Ensure proper grounding and follow elec 1. **Moving Parts**: Keep hands and loose clothing away from moving parts 2. **Sample Handling**: Use appropriate tools when handling samples -3. **Weight**: Use proper lifting techniques when moving the microscope (~20Kg) +3. **Weight**: Use proper lifting techniques when moving the microscope (~20kg) 4. **Sharp Edges**: Be aware of sharp edges on optical components and mounts -5. **Rapid Prototyping**: Customize optical systems ### Chemical Safety @@ -121,14 +120,16 @@ Certain components of the FRAME system may be covered by patents. For current pa ## Emergency Procedures ### Electrical Emergency -1. Immediately disconnect power at the main switch -2. Do not touch exposed electrical components -3. Contact qualified service personnel +1. Immediately press emergency stop button +2. Immediately disconnect power at the main switch +3. Do not touch exposed electrical components +4. Contact qualified service personnel ### Fire Emergency -1. Disconnect power immediately -2. Use appropriate fire extinguisher -3. Evacuate area if necessary +1. Immediately press emergency stop button +2. Disconnect power immediately +3. Use appropriate fire extinguisher +4. Evacuate area if necessary ### Chemical Spill 1. Follow laboratory chemical spill procedures diff --git a/docs/03_Investigator/02_FRAME/02_Introduction_and_Overview.md b/docs/03_Investigator/02_FRAME/02_Introduction_and_Overview.md index fa4ef9da6..c2f2218ad 100644 --- a/docs/03_Investigator/02_FRAME/02_Introduction_and_Overview.md +++ b/docs/03_Investigator/02_FRAME/02_Introduction_and_Overview.md @@ -2,7 +2,7 @@ ## What is the FRAME Microscope? -The **FRAME** (Fast Rigid Automated Microscope Engine) represents a new approach to microscopy: an open, modular, automated, and flexibly adaptable microscope system. Based on the modular optics construction kit UC2 (You.See.Too.), the FRAME system lowers barriers to access complex optical and microscopy technology. +The **FRAME** (Fast Rigid Automated Microscope Engine) represents a new approach to microscopy: an open, modular, automated, and flexibly adaptable microscope system. Based on UC2's (You.See.Too.) modular optics kit, the FRAME system lowers barriers to access complex optical and microscopy technology. ## System Philosophy @@ -11,7 +11,7 @@ The **FRAME** (Fast Rigid Automated Microscope Engine) represents a new approach The FRAME system is built on complete modularization of all components regarding mechanics, electronics, and software: - **Interchangeable Modules**: Cube modules can be freely exchanged to switch between brightfield, fluorescence, or interference microscopy -- **Flexible Mechanics**: Allows both classical objective setups and free arrangement for special geometries +- **Flexible Mechanics**: Allows both, classical objective setups and free arrangements for special geometries - **Smart Electronics**: Each cube can optionally have its own control unit for motors, galvo mirrors, or LEDs. All components share the same CAN BUS via 12V supply voltage. - **Open Interface**: System control via user-friendly graphical interface or programming interface (Python, REST, CAN BUS, USB) @@ -31,7 +31,7 @@ The FRAME system is built on complete modularization of all components regarding - **Precision XYZ System**: High-accuracy positioning and focusing mechanisms - **Removable Optics Unit**: Modular design allows easy reconfiguration - **Slide-In System**: Standardized 50mm cubes with quick-exchange capability -- **Linear Objective Revolver**: Decide between two different magnifications/resolutions +- **Linear Objective Revolver**: Switch between two different magnifications/resolutions ### Electronic Architecture @@ -61,9 +61,8 @@ The FRAME system integrates with several software platforms: ### Industrial Applications 1. **Quality Control**: Materials inspection and defect analysis -2. **Semiconductor Industry**: Wafer inspection and process control -3. **Biotechnology**: Process monitoring and product validation -4. **Education**: Modern imaging technique visualization in teaching and training +2. **Biotechnology**: Process monitoring and product validation +3. **Education**: Modern imaging technique visualization in teaching and training ### Advantages for Different User Groups @@ -98,7 +97,7 @@ The modular approach contributes to sustainability on multiple levels: ### Open Source Benefits - **Global Accessibility**: Electronic platforms can be replicated worldwide, including in resource-limited regions -- **Knowledge Sharing**: Open documentation promotes global access to high technology +- **Knowledge Sharing**: Open documentation promotes global access to high-end technology - **Community Development**: Active community ensures continuous improvement and support - **Local Repairs**: Using 3D printing and digital fabrication, broken parts can be repaired on site diff --git a/docs/03_Investigator/02_FRAME/03_Technical_Specifications.md b/docs/03_Investigator/02_FRAME/03_Technical_Specifications.md index d6e65c598..7a918a74e 100644 --- a/docs/03_Investigator/02_FRAME/03_Technical_Specifications.md +++ b/docs/03_Investigator/02_FRAME/03_Technical_Specifications.md @@ -12,14 +12,15 @@ ![](./IMAGES/02/FRAME_Overview_2.png) -### Overall System Dimensions +### Overall System Dimensions (including illumination arm) | Parameter | Motorized Version | |-----------|-------------------| -| Width | 250 mm | -| Depth | 250 mm | -| Height | 250 mm | -| Weight | 20 kg | +| Width | 310 mm | +| Depth | 410 mm | +| Height | 400 mm | +| Weight | 25 kg | + ### Mechanical Specifications @@ -27,14 +28,7 @@ - **Material**: Anodized aluminum profiles and plates - **Vibration Damping**: Integrated damping system (bumper feed) - **Stage**: Integrated XYZ Stage in one mechanical design -- **Objective Revolver**: 2 Slots for multiple magnifications/resolutions (max diameter <28mm) - -#### XYZ Positioning System -- **X-Y Travel Range**: up to 120 × 90 mm (Well plate format), stepsize: ~300nm -- **Z-Travel Range**: 8 mm, stepsize: ~300nm -- **Resolution**: 0.3 μm (motorized) -- **Accuracy**: ±XXXX μm -- **Repeatability**: ±0.5 μm +- **Objective Revolver**: 2 Slots for multiple magnifications/resolutions ### Optical Specifications @@ -79,7 +73,7 @@ #### Camera Interface - **Mount Type**: C-mount - **Sensor Compatibility**: CMOS -- **Available Cameras:** HIK IMX 179, IMX275 +- **Available Cameras:** HIK IMX179, IMX275 - **Connection**: USB 3.0 - **Trigger**: Hardware and software trigger support @@ -138,7 +132,7 @@ Frontend-only: ### Environmental Requirements #### Operating Conditions -- **Temperature**: 5°C to 38°C (59°F to 95°F) +- **Temperature**: 15°C to 35°C - **Humidity**: 30% to 80% relative humidity, non-condensing - **Atmospheric Pressure**: 86 kPa to 106 kPa - **Altitude**: Up to 2000 m above sea level @@ -148,7 +142,7 @@ Frontend-only: - **Humidity**: 10% to 95% relative humidity, non-condensing #### Installation Requirements -- **Vibration**: Isolated surface recommended for best performance +- **Vibration**: optical table with vibration damping recommended for best performance - **Space**: 1 m × 1.5 m minimum work area - **Power**: 230V AC, 50/60 Hz (or 115V AC with adapter) - **Ventilation**: Natural convection (no forced ventilation required) @@ -157,19 +151,11 @@ Frontend-only: ### Inner Cube System -#### Cube Drawer Mechanism -- **Number of Positions**: 4 cube positions (configurable) -- **Drawer Travel**: 150mm sliding range per position -- **Drawer Rails**: Precision linear ball bearing guides -- **Load Capacity**: 500g per cube position -- **Positioning Accuracy**: ±0.05mm repeatability -- **Locking Mechanism**: Spring-loaded detent system - #### Cube Modules (Standard 50mm) #### Mechanical Specifications - **Dimensions**: 50 × 50 × 50 mm -- **Material**: Anodized aluminum or 3D-printed PLA/PETG +- **Material**: ABS / injection molded - **Precision**: ±0.1 mm dimensional accuracy - **Interface**: Dovetail connection system - **Mounting**: Threaded inserts M3 and M4 compatible @@ -190,9 +176,12 @@ Frontend-only: ### Stage System -#### Motorized Stage -- **Travel Range**: 75 × 50 mm (standard), 150 × 100 mm (extended) -- **Resolution**: 0.1 μm +#### XYZ Positioning System (Motorized Stage) +- **X-Y Travel Range**: 75 × 50 mm (standard), up to 120 × 90 mm (extended), stepsize: ~300nm +- **Z-Travel Range**: 8 mm, stepsize: ~300nm +- **Resolution**: 0.3 μm (motorized) +- **Accuracy**: ±XXXX μm +- **Repeatability**: ±0.5 μm - **Speed**: 0.1 μm/s to 10 mm/s - **Acceleration**: Programmable, up to 100 mm/s² - **Load Capacity**: 2 kg maximum @@ -204,7 +193,7 @@ Frontend-only: - **Resolution**: 0.05 μm - **Speed**: 0.1 μm/s to 5 mm/s - **Repeatability**: ±0.1 μm -- **Autofocus**: Laser-based or image-based +- **Autofocus**: Laser-based or image-based (optional) ## Compatibility and Standards diff --git a/docs/03_Investigator/02_FRAME/04_Installation_and_Setup.md b/docs/03_Investigator/02_FRAME/04_Installation_and_Setup.md index f897a481f..1310c446f 100644 --- a/docs/03_Investigator/02_FRAME/04_Installation_and_Setup.md +++ b/docs/03_Investigator/02_FRAME/04_Installation_and_Setup.md @@ -5,25 +5,96 @@ Before beginning installation, ensure you have: - [ ] Read all safety information in [Safety and Compliance](./01_Safety_and_Compliance.md) -- [ ] Verified environmental conditions meet specifications +- [ ] Verified environmental conditions meet specifications in [Technical Specifications](./03_Technical_Specifications.md) - [ ] Prepared adequate workspace (minimum 1 m × 1.5 m) - [ ] Organized necessary tools (see Tool Requirements below) -- [ ] Verified power supply compatibility +- [ ] Verified power supply compatibility in [Technical Specifications](./03_Technical_Specifications.md) +### Package Inspection + +1. **Upon Delivery**: + - Inspect packaging for damage during shipment + - Document any visible damage with photographs + - Check that all packages are received according to packing list + +2. **Unpacking Procedure**: + - Use proper lifting techniques (system weight: 25-35 kg) + - Remove packaging materials carefully to avoid damage + - Keep packaging materials until installation is complete + - Verify all components against the packing list + +### Standard Package Contents - Packing List + +#### Main System Components +- [ ] FRAME main unit (frame and base assembly) +- [ ] XYZ positioning system +- [ ] Illumination arm incl. light source (2x1 cubes) +- [ ] Control electronics unit +- [ ] camera +- [ ] Power supply for FRAME +- [ ] USB/CAN interface cables +- [ ] Camera cable +- [ ] USB-A to USB-C Cable +- [ ] Emergency Stop + +#### Optical Components +- [ ] Optical Module preconfigured (3x3x2 Cubes) +- [ ] Objectives as ordered +- [ ] Camera interface adapter + +#### Laser Module +- [ ] separate Laser module (3x2x1 cubes) +- [ ] Laser safety cover +- [ ] separate Laser (if applicable) +- [ ] separate Power supply for Laser (if applicable) +- [ ] Separate key + +#### Accessories +- [ ] Sample holders and clips +- [ ] Biological test specimen +- [ ] Calibration target +- [ ] Ruler Target +- [ ] PS4-Controller +- [ ] Tool kit +- [ ] Documentation package +- [ ] Software installation media/download links +### Tool Requirements +#### Essential Tools +- Allen key set (2, 3, 4, 5, 6 mm) +- Phillips head screwdriver +- Flathead screwdriver +- Adjustable wrench +- Digital multimeter (for electrical verification) + +#### Optional Tools +- Optical cleaning supplies +- Antistatic wrist strap +- Digital level +- Vibration measurement device +## Unpacking +![](./IMAGES/04/Case-in-bubble-foil.jpeg) +*Take Case wrapped in bubble foil out of cardboard box.* -## Package Contents and Unpacking +![](./IMAGES/04/case-closed.jpg) +*Case, that holds the FRAME inside, with bubble foil removed.* -![](./IMAGES/04/FRAME_Manual_1.jpeg) -*Case that holds the Frame, carefully open it and ensure that there is no outer damage to the package. Store this box carefully and reuse it if necessary - it's a great suit case :)* +![](./IMAGES/04/FRAME-in-open-case.jpeg) +*Carefully open the case and ensure that there is no outer damage to the package. Store this case carefully and reuse it if necessary - it's a great suit case :)* +![](./IMAGES/04/Transport-lock-on-top-of-FRAME.jpeg) +![](./IMAGES/04/Transport-lock.jpeg) +*Remove the Transport lock on top of the FRAME.* -![](./IMAGES/04/FRAME_Manual_2.jpeg) +![](./IMAGES/04/FRAME-in-open-case+parts.jpeg) *The FRAME is covered with packaging material, foam and bubble foil, unwrap the parts and take out the components, starting with the smaller parts, including the illumination arm. The FRAME body itself is very heavy, so please make sure you get additional support and move the box out of the suitcase carefully. Hold it from the lower end* **don't lift it holding the Z-stage!**, *put this on a surface that is decently stable!* +![](./IMAGES/04/Transport-protection-within-stage.jpeg) +**Don't forget to remove all foam parts inside the stage.** + ## Frame Positioning and Setup ### Initial Frame Positioning @@ -33,19 +104,17 @@ Before beginning installation, ensure you have: ⚠️ CAUTION: Use proper lifting techniques. Two-person lift recommended. ``` - Place frame on designated work surface - - Ensure all adjustment feet make contact with surface - - Do not overtighten adjustment feet 2. **Level the System**: - - Use built-in bubble level or digital level - - Adjust feet until level in both X and Y directions + - Use bubble level or digital level + - Adjust position on surface until level in both X and Y directions - Verify stability by gently pressing corners - Re-check level after 30 minutes 3. **Surface Requirements**: - Stable, level surface capable of supporting 50 kg - Minimal vibration environment - - Away from air conditioning vents and heat sources + - Place away from air conditioning vents and heat sources - Good lighting for assembly work 4. **Power Requirements**: @@ -59,9 +128,6 @@ Before beginning installation, ensure you have: - Humidity: 30% to 80% RH, non-condensing - Clean environment, minimal dust -![](./IMAGES/04/FRAME_Manual_3.jpeg) -*Package contents: The FRAME, emergency stop, power supply, USB cables (camera, ESP32) and illumination arm* - ## Component Installation ### Mounting the Illumination Arm @@ -75,9 +141,6 @@ Before beginning installation, ensure you have: ![](./IMAGES/04/FRAME_Manual_5.jpeg) *Attach the CAN bus cables from the illumination arm to the electronics board by plugging them into the junction board* -![](./IMAGES/04/FRAME_Manual_8.jpeg) -*Ensure the illumination cubes in the upper cube slot are optically aligned. Note: The cable must be plugged in with the CAN bus connector reversed (manufacturing note for first version - ensure the "nose" points in the same direction as the LEDs)* - ![](./IMAGES/04/FRAME_Manual_9.jpeg) *Secure the cable and optionally add the protective lid* @@ -91,9 +154,7 @@ Before beginning installation, ensure you have: *Plugging in the Emergency stop (Audio Jack) into the rear electronics that controls the microscope. Plug it into the slot with the audio jack that says emergency stop*. **Activate the emergency stop by pressing it** ![](./IMAGES/04/FRAME_Manual_13.jpeg) -*Connect the ESP32 control board that runs the UC2 Firmware (youseetoo.github.io) with the Raspberry Pi using the USB-C to USB-A cable (you can either use the blue USB3 or black USb2 slots)* - - +*Connect the ESP32 control board that runs the UC2 Firmware (youseetoo.github.io) with the Raspberry Pi using the USB-C to USB-A cable (you can either use the blue USB3 or black USb2 slots)* ![](./IMAGES/04/FRAME_Manual_15.jpeg) *Mount the USB3 Camera cable and lock the screws on the camera side* @@ -131,7 +192,7 @@ The PS4 controller and web interface operations are covered in detail in the [Op ### Mounting Optics ![](./IMAGES/04/FRAME_Manual_22.jpeg) -*Unbox the objective lenses and insert them in the dedicated slots by screwing them into the RMS Threads. Be careful not to touch the surfaces* +*Unbox the objective lenses and insert them in the dedicated slots by screwing them into the RMS Threads. Remove the stickers from the objective mounts before. Be careful not to touch the surfaces* ![](./IMAGES/04/FRAME_Manual_23.jpeg) *Do the same for objective #2. The order depends on the configuration you have and must be mirrored in the configuration file.* @@ -153,12 +214,6 @@ You can also reference the online configuration repository: 🔗 https://github.com/openUC2/ImSwitchConfig/blob/master/imcontrol_setups/FRAME2.json -![](./IMAGES/04/FRAME_Manual_25.jpeg) -*add the laser cover at the side* - -![](./IMAGES/04/FRAME_Manual_26.jpeg) -*Secure the laser cover by snapping it in place* - ## Software Installation and Configuration ### Prerequisites @@ -205,6 +260,12 @@ If you need to install ImSwitch locally on your computer: Laser safety is paramount when working with the FRAME system. The device incorporates multiple safety mechanisms to ensure Class 1 laser operation, meaning no dangerous radiation can escape the device enclosure when properly assembled. +![](./IMAGES/04/FRAME_Manual_25.jpeg) +*add the laser cover at the side* + +![](./IMAGES/04/FRAME_Manual_26.jpeg) +*Secure the laser cover by snapping it in place* + ### Safety Mechanisms The FRAME incorporates three primary safety systems: @@ -312,57 +373,6 @@ The FRAME incorporates three primary safety systems: For information about using the sample calibration target, see the [Operation Manual](./05_Operation_Manual.md) section on calibration procedures. -### Package Inspection - -1. **Upon Delivery**: - - Inspect packaging for damage during shipment - - Document any visible damage with photographs - - Check that all packages are received according to packing list - -2. **Unpacking Procedure**: - - Use proper lifting techniques (system weight: 25-35 kg) - - Remove packaging materials carefully to avoid damage - - Keep packaging materials until installation is complete - - Verify all components against the packing list - -### Standard Package Contents - -#### Main System Components -- [ ] FRAME main unit (frame and base assembly) -- [ ] XYZ positioning system -- [ ] Control electronics unit -- [ ] Power supply and cables -- [ ] USB/CAN interface cables - -#### Optical Components (inside the optics cube) -- [ ] Basic cube module set -- [ ] Tube lens assembly -- [ ] Condenser system -- [ ] LED illumination module -- [ ] Camera interface adapter - -#### Accessories -- [ ] Sample holders and clips -- [ ] Calibration slides -- [ ] Tool kit -- [ ] Documentation package -- [ ] Software installation media/download links - -### Tool Requirements - -#### Essential Tools -- Allen key set (2, 3, 4, 5, 6 mm) -- Phillips head screwdriver -- Flathead screwdriver -- Adjustable wrench -- Digital multimeter (for electrical verification) - -#### Optional Tools -- Optical cleaning supplies -- Antistatic wrist strap -- Digital level -- Vibration measurement device - ## Software Installation and Configuration **Work In Progress**: This is for the case if you want to install imswotch locally.. @@ -425,7 +435,7 @@ This document covers: ### Quick Alignment Summary 1. **Prepare Internal Cube**: - - Remove cube from FRAME + - Remove optical module from FRAME - Set up external alignment fixture - Align fluorescence path for Köhler illumination - Center laser beam exit from objective @@ -465,9 +475,6 @@ The FRAME uses a well-defined coordinate system for precise positioning. Complet *Coordinate system directions and axis orientations* - - - ### Step 1: Illumination Alignment **Note: This section is under development. Complete procedures will be provided in future updates.** @@ -534,28 +541,28 @@ The FRAME system supports custom objective holders for specialized applications. The modular cube system allows for custom optical configurations. Detailed procedures for creating custom optical layers will be provided in future documentation updates. -In a nutshell: the different layers of the FRAME can be constructed freely upon users needs. The current version has a 3x3x3 inner cube, but it can be adjusted to be longer in the Y direction (e.g. 3x5xN) and in the Z-direction by stacking additional layers and increasing outer pillars' height. The below layers demonstrate how a brightfield imaging setup with a simple folding mirror, a tube lens and a camera can be constructed. Additionally we have a fluorescence layer with a fiber holder, the optics to shape the beam and the kinematic dichroic to focus it in the back focal plane from the imaging objective. +In a nutshell: the different layers of the FRAME can be constructed freely upon users needs. The current version has a 3x3x2 inner cube-array, but it can be adjusted to be longer in the Y direction (e.g. 3x5xN) and in the Z-direction by stacking additional layers and increasing outer pillars' height. The below layers demonstrate how a brightfield imaging setup with a simple folding mirror, a tube lens and a camera can be constructed. Additionally we have a fluorescence layer with a fiber holder, the optics to shape the beam and the kinematic dichroic to focus it in the back focal plane from the imaging objective. ![](./IMAGES/04/FRAME_LAYER_7.jpg) -*All necessary components* +*All necessary components - except mirror dicroic mirror of fluroescence layer* ![](./IMAGES/04/FRAME_LAYER_6.jpg) -*Constructing the Fluorescence Layer* +*Constructing the Fluorescence Layer on top of the Brightfield layer to build a 3x3x2 cube-array* ![](./IMAGES/04/FRAME_LAYER_5.jpg) -*Adding Fluorescence Layer to Imaging Layer* +*Adding Top Plate on top of the cube-array* ![](./IMAGES/04/FRAME_LAYER_4.jpg) -*Locking Layers with extended screws* +*Locking the whole cube-array with extended screws* ![](./IMAGES/04/FRAME_LAYER_3.jpg) *Ensuring the screws have a tight fit across all layers* ![](./IMAGES/04/FRAME_LAYER_2.jpg) -*Ready to use cube that can be pre-alligned with optics on top* +*Ready to use cube-array that can be pre-alligned with optics on top* ![](./IMAGES/04/FRAME_LAYER_1.jpg) -*Insert pre-alligned cube into the FRAME* +*Insert pre-alligned 3x3x2 cube-array into the FRAME* diff --git a/docs/03_Investigator/02_FRAME/05_Operation_Manual.md b/docs/03_Investigator/02_FRAME/05_Operation_Manual.md index 373f2f29c..b34fbe6e2 100644 --- a/docs/03_Investigator/02_FRAME/05_Operation_Manual.md +++ b/docs/03_Investigator/02_FRAME/05_Operation_Manual.md @@ -16,8 +16,16 @@ ``` - Connect 12V power supply - Wait for system self-test to complete (LED indicators and homing on startup) + +ToDo Armin 250813: LED Indicators beschreiben, nur sichtbare für den Kunden, woran erkennt der Kunde, dass der Selftest vorbei ist und okay ist? +Was sagen die LEDs aus +LEDs Laser Modul +LEDs connector Board +LED ESP32 grün blinkend +Rote LED am Netzteil => Netzteil angeschlossen +LAN Kabel LED - XY axes will home and move to 0,0 position (disable by setting `homeOnStartX:0` in configuration file) - - Start computer and control software + - Start computer and ImSwitch control software - Allow 15-minute warm-up period for thermal stability if placed in an incubator 3. **System Initialization**: @@ -47,7 +55,34 @@ The FRAME system is fully motorized and operated through software interfaces. Al - **ImSwitch Web Interface**: Primary graphical user interface accessible via web browser - **PS4 Controller**: Alternative hardware interface for manual positioning and control -### Basic Microscopy Setup +**Short Introduction PS4 Controller operation** +- FRAME powered on, Self Tests and homing done, ESP32 ready +- PS4 Controller connects via bluetooth +- PS4 Controller - not connected + +![WhatsApp Bild 2025-08-14 um 11 05 17_498f94de](https://github.com/user-attachments/assets/a0b7e141-a334-4607-95d2-2729d8efb479) +PS4-Controller + +![WhatsApp Bild 2025-08-14 um 11 05 17_d300ffc5](https://github.com/user-attachments/assets/069ecc4b-a7b7-4256-9b9e-94d18f680e71) +Light Bar (PS4 turned off) + +![WhatsApp Bild 2025-08-14 um 14 08 59_3c7d1f66](https://github.com/user-attachments/assets/003850d0-cb88-4d72-8557-a0642de52a87) +Light Bar PS4 Connected (red) + +![WhatsApp Bild 2025-08-14 um 14 04 31_b3826f29](https://github.com/user-attachments/assets/15081a01-7b6e-4a5b-b9b1-5adbf17462ed) +Light Bar PS4 charging and NOT connected (yellow) + +- Press Home button for a couple of seconds (triangular button between joysticks), light bar shortly blinks and then shows steady light = succesful connection +Test X/Y/Z movement and lamp on/off according to +grafik + +(X/Y and Z Joystick testet, A not implemented, Lamp on/off tested, Z buttons not tested (needs imaging)) + +Turning off PS4 => press home button for roughly 30s +If PS4 cannot connect light bar blinks for around 15s,then turns off +If connection gets lost, light bar tunrs off after around 5s. + +**Basic Microscopy Setup** #### Sample Preparation and Loading @@ -277,7 +312,7 @@ Before installing any cube modules: 2. Inspect locking interface for damage 3. Contact technical support if mechanism repair is required (see our forum) -### Safety Considerations for Inner Cube System +### Safety Considerations for working on Inner Cube System ``` ⚠️ WARNING: Always power down system before cube manipulation @@ -314,7 +349,8 @@ The FRAME system integrates with ImSwitch software for comprehensive control: - **Illumination Control**: Light source intensity and switching - **Acquisition Settings**: Camera and recording parameters -**Additional Controllers**: The system includes various controllers that merge different functionalities between hardware, image processing, and software: +**Additional Controllers**: Your custom system configuration can include various other controllers that merge different functionalities between hardware, image processing, and software, such as: + - **Autofocus Controller**: Takes a series of images while moving the stage and moves to the position with highest contrast - **Experiment Controller**: Enables area scanning and stitching - **Backend Controllers**: Provide functionality through the React-based web application @@ -337,13 +373,9 @@ When objective magnification changes, the effective pixel size changes and requi 3. Open the file in Fiji to measure the number of pixels for a given unit on the calibration slide 4. Calculate pixel size: divide the known distance (e.g., 1 millimeter) by the number of pixels (e.g., 1000 pixels) to get pixel size (1 micrometer in this example) -The procedure is explained in the video: -![](./IMAGES/04/calibratingpixelsize.mp4) - **Capturing a Large Panorama Using Multiple Tiles and Opening in Fiji** -The experiment controller has a built-in sample overview map where you can select an area using the max dome selector. This area is then scanned sequentially in XY to produce a stitched imaging result. The procedure is explained in the video: -![](./IMAGES/04/creatingtiledimage.mp4) +The experiment controller has a built-in sample overview map where you can select an area using the max dome selector. This area is then scanned sequentially in XY to produce a stitched imaging result. #### PS4 Controller Operation diff --git a/docs/03_Investigator/02_FRAME/06_Maintenance_and_Troubleshooting.md b/docs/03_Investigator/02_FRAME/06_Maintenance_and_Troubleshooting.md index 530a0a94d..6de0ed9a0 100644 --- a/docs/03_Investigator/02_FRAME/06_Maintenance_and_Troubleshooting.md +++ b/docs/03_Investigator/02_FRAME/06_Maintenance_and_Troubleshooting.md @@ -653,37 +653,4 @@ Warranty void if: - Bulk discounts available for educational institutions -### Thermo Images of the Device in the incubator - -![alt text](./IMAGES/06/thermo/FLIR_20250605_075355_898.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075349_324.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075400_761.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075253_681.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075324_364.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075301_904.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075314_059.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075305_964.jpg) -![alt text](./IMAGES/06/thermo/FLIR_20250605_075255_428.jpg) - - -### Scanning of multiple tiles - -![](./IMAGES/06/VID_20250528_145252.mp4) - -*Continue to [Appendix](./07_Appendix.md) for additional reference information.* - -### Images from the current revision - -![alt text](./IMAGES/06/gallery/IMG_1009.png) -![alt text](./IMAGES/06/gallery/IMG_1008.png) -![alt text](./IMAGES/06/gallery/IMG_1010.png) -![alt text](./IMAGES/06/gallery/IMG_1017.png) -![alt text](./IMAGES/06/gallery/IMG_1013.png) -![alt text](./IMAGES/06/gallery/IMG_1012.png) -![alt text](./IMAGES/06/gallery/IMG_1018.png) -![alt text](./IMAGES/06/gallery/IMG_1014.png) -![alt text](./IMAGES/06/gallery/IMG_1020.png) -![alt text](./IMAGES/06/gallery/IMG_1021.png) -![alt text](./IMAGES/06/gallery/IMG_1019.png) -![alt text](./IMAGES/06/gallery/IMG_1015.png) -![alt text](./IMAGES/06/gallery/IMG_1016.png) \ No newline at end of file +*Continue to [Appendix](./07_Appendix.md) for additional reference information.* \ No newline at end of file diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/Archiv/Temp b/docs/03_Investigator/02_FRAME/IMAGES/04/Archiv/Temp new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/docs/03_Investigator/02_FRAME/IMAGES/04/Archiv/Temp @@ -0,0 +1 @@ + diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/Case-in-bubble-foil.jpeg b/docs/03_Investigator/02_FRAME/IMAGES/04/Case-in-bubble-foil.jpeg new file mode 100644 index 000000000..60be9b6a0 Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/Case-in-bubble-foil.jpeg differ diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/FRAME-in-open-case+parts.jpeg b/docs/03_Investigator/02_FRAME/IMAGES/04/FRAME-in-open-case+parts.jpeg new file mode 100644 index 000000000..1d2c005af Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/FRAME-in-open-case+parts.jpeg differ diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/FRAME-in-open-case.jpeg b/docs/03_Investigator/02_FRAME/IMAGES/04/FRAME-in-open-case.jpeg new file mode 100644 index 000000000..61eecf23f Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/FRAME-in-open-case.jpeg differ diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-lock-on-top-of-FRAME.jpeg b/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-lock-on-top-of-FRAME.jpeg new file mode 100644 index 000000000..f8fece8c3 Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-lock-on-top-of-FRAME.jpeg differ diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-lock.jpeg b/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-lock.jpeg new file mode 100644 index 000000000..6feb01f6b Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-lock.jpeg differ diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-protection-within-stage.jpeg b/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-protection-within-stage.jpeg new file mode 100644 index 000000000..7735610f4 Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/Transport-protection-within-stage.jpeg differ diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/case-closed.jpg b/docs/03_Investigator/02_FRAME/IMAGES/04/case-closed.jpg new file mode 100644 index 000000000..b4c2977a2 Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/case-closed.jpg differ diff --git a/docs/03_Investigator/02_FRAME/IMAGES/04/empty-case-open.jpg b/docs/03_Investigator/02_FRAME/IMAGES/04/empty-case-open.jpg new file mode 100644 index 000000000..0a4fa20d9 Binary files /dev/null and b/docs/03_Investigator/02_FRAME/IMAGES/04/empty-case-open.jpg differ diff --git a/docs/03_Investigator/02_FRAME/config_examples/Coordinate_System_Reference.md b/docs/03_Investigator/02_FRAME/config_examples/Coordinate_System_Reference.md index c4ec6c4e4..6db703f51 100644 --- a/docs/03_Investigator/02_FRAME/config_examples/Coordinate_System_Reference.md +++ b/docs/03_Investigator/02_FRAME/config_examples/Coordinate_System_Reference.md @@ -16,6 +16,8 @@ A calibration sample is provided to help locate the central reference point at c The calibration target features lines that help users navigate to the center position and can also be used with fluorescence illumination. +ToDo Armin 250804: Mehr erklärungen dazu? Was sehe ich hier und warum? + [Video demonstration link](https://private-user-images.githubusercontent.com/4345528/452977251-b087b719-b484-41d8-b0e7-49d4ae4ada15.mp4?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NTExMTA1MzYsIm5iZiI6MTc1MTExMDIzNiwicGF0aCI6Ii80MzQ1NTI4LzQ1Mjk3NzI1MS1iMDg3YjcxOS1iNDg0LTQxZDgtYjBlNy00OWQ0YWU0YWRhMTUubXA0P1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDYyOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTA2MjhUMTEzMDM2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YjA3ZDU1NzBkYzc5NThiNDMwZGZhNzkyZmY5MTk1ZDk3N2YxMGViMDZiNWFkOGRjMWJjZDk0NjZmY2FlN2FjZSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.wD7zmcY7i3mIm-uPqRfzKZ8akXAnvusnY2rnNYxrlNU) ### Stage Travel Range @@ -26,6 +28,9 @@ The maximum travel range is 127 x 86 mm, suitable for multiwell plates: *Stage coordinate system showing maximum travel range* +ToDo Armin 250804: Das linke untere Bild ist für mich schwer verständlich und ergibt auch keinen Sinn (die Objektive sind verschoben zum Strahlengang/beleuchtung) +Was soll die Aussage des Bildes sein? + ### Axis Directions The coordinate system directions and orientations are defined as follows: @@ -34,6 +39,10 @@ The coordinate system directions and orientations are defined as follows: *Detailed coordinate system showing axis directions and orientations* +ToDo Armin 250804: Was sagt das a ... 0 im rechten oberen Bild aus? +Auf dem Joystick ist zwei mal Y? Soll der rechte Button Z anstatt Y sein? + + ## Calibration Procedures ### Stage Position Calibration @@ -43,6 +52,8 @@ The coordinate system directions and orientations are defined as follows: 3. **Record Offset**: Note the difference between displayed and actual positions 4. **Update Configuration**: Enter the offset values in the ImSwitch configuration +ToDo Armin 250804: Hier detaillierter beschreiben? Halte ich für notwendig, wenn der Kunde anhand dieser Anleitung in der Lage sein soll, eigenständig zu kalibrieren. + ### Optical Alignment For detailed optical alignment procedures, see: @@ -55,4 +66,6 @@ For detailed optical alignment procedures, see: - **Calibration Point**: 63.5/46 mm - **Maximum Travel**: 127 x 86 mm - **Resolution**: 0.3125 μm per step (configurable) -- **Repeatability**: ±2 μm (typical) \ No newline at end of file +- **Repeatability**: ±2 μm (typical) + +ToDo Armin 250804: Angaben nicht vollständig konsistent zu 03_Technical_Specifications.md. Z.B. Repeatbility unterschiedlich und auch Travel range. diff --git a/docs/03_Investigator/02_FRAME/config_examples/Optical_Alignment_Procedures.md b/docs/03_Investigator/02_FRAME/config_examples/Optical_Alignment_Procedures.md index 77031efef..9edd3b270 100644 --- a/docs/03_Investigator/02_FRAME/config_examples/Optical_Alignment_Procedures.md +++ b/docs/03_Investigator/02_FRAME/config_examples/Optical_Alignment_Procedures.md @@ -2,17 +2,17 @@ ## Overview -The FRAME system requires precise optical alignment to ensure optimal performance. This document provides detailed procedures for aligning the internal optics cube and calibrating the optical path. +The FRAME system requires precise optical alignment to ensure optimal performance. This document provides detailed procedures for aligning the internal optics module and calibrating the optical path. ## Internal Optics Cube Preparation ### Initial Setup Outside the FRAME -Before installing the internal optics cube in the FRAME, it must be properly aligned using a separate alignment setup. +Before installing the internal optics module in the FRAME, it must be properly aligned using a separate alignment setup. #### Components to Align -The internal optics cube contains three main optical elements that must be aligned: +The internal optics module contains three main optical elements that must be aligned: 1. **Transmitted light module** with camera and folding mirror 2. **Fluorescence excitation module** 3. **Objective mounting system** @@ -20,13 +20,13 @@ The internal optics cube contains three main optical elements that must be align #### Alignment Setup 1. **Create External Test Setup**: - - Remove the internal optics cube from the FRAME - - Build a test setup on top of the cube that mimics the FRAME's optical distances + - Remove the internal optics module from the FRAME + - Build a test setup on top of the module that mimics the FRAME's optical distances - Mount an objective in the test setup to maintain proper optical spacing 2. **Software Preparation**: - Start ImSwitch software to enable camera viewing - - Ensure proper communication with the cube's electronics + - Ensure proper communication with the module's electronics ### Fluorescence Module Alignment @@ -48,12 +48,12 @@ The internal optics cube contains three main optical elements that must be align #### Mechanical Alignment 1. **Access Adjustment Screws**: - - Use a 2.5mm hex key to access the three adjustment screws on the back of the cube + - Use a 2.5mm hex key to access the three adjustment screws on the back of the module - These screws control the position and angle of the optical elements 2. **Laser Centering**: - Ensure the laser focus is exactly centered where the objective will be positioned - - The light beam must exit the internal cube parallel to the optical axis + - The light beam must exit the internal module parallel to the optical axis - This ensures proper Köhler illumination 3. **Objective Installation**: @@ -70,13 +70,13 @@ The internal optics cube contains three main optical elements that must be align ### Objective-to-FRAME Alignment -After internal cube alignment, align the optical axis of the FRAME with the internal cube. +After internal module alignment, align the optical axis of the FRAME with the internal module. #### Available Adjustments Two adjustment mechanisms are available: 1. **X-axis**: Objective can be moved along the X-axis using the slide mechanism -2. **Y-axis**: Internal cube can be moved relative to the FRAME using adjustment screws +2. **Y-axis**: Internal module can be moved relative to the FRAME using adjustment screws #### LED Alignment Tool Setup @@ -97,7 +97,7 @@ Two adjustment mechanisms are available: - Observe the point light source projected to the back focal plane 2. **Y-axis Alignment**: - - Adjust the internal cube position along Y-axis using the adjustment screw + - Adjust the internal module position along Y-axis using the adjustment screw - Move the light point to the center of the back focal plane - Use a piece of paper with crosshairs to mark the position @@ -133,9 +133,9 @@ Two adjustment mechanisms are available: Once all optical elements are properly aligned: -1. **Secure Internal Cube**: - - Tighten the locking knobs to permanently secure the internal cube in the rail - - Ensure the cube cannot move during operation +1. **Secure Internal Module**: + - Tighten the locking knobs to permanently secure the internal module in the rail + - Ensure the module cannot move during operation 2. **System Testing**: - Perform comprehensive testing of all optical functions @@ -171,4 +171,4 @@ Once all optical elements are properly aligned: - Regular cleaning of optical surfaces - Periodic verification of alignment - Check mechanical adjustments for wear -- Update position calibrations as needed \ No newline at end of file +- Update position calibrations as needed