Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
6ac3173
first test
beniroquai Jul 3, 2026
ea313e4
updating corebox docs to diataxis using Claude (sorry...)
beniroquai Jul 6, 2026
5a4bcd8
update images corebox
beniroquai Jul 9, 2026
d842449
Merge branch 'master' into test/diataxis
beniroquai Jul 9, 2026
7ae56c3
claude proposed structure for setting up frame based on notion input …
beniroquai Jul 9, 2026
231c469
working on diataxis corebox
beniroquai Jul 14, 2026
3fa3151
Changes 14 Juli
Mikrodoktor Jul 15, 2026
e98d86d
Merge branch 'test/diataxis' of https://github.com/openUC2/docs into …
Mikrodoktor Jul 15, 2026
95b325c
Update 160726
Mikrodoktor Jul 16, 2026
4216b87
Update 260717
Mikrodoktor Jul 17, 2026
a90c15b
Update 260717 Teil 2
Mikrodoktor Jul 17, 2026
86f1e83
Update 260727
Mikrodoktor Jul 27, 2026
d086864
Update 260728
Mikrodoktor Jul 28, 2026
9ceccd3
update2 260728
Mikrodoktor Jul 28, 2026
b54ade7
Update 260729
Mikrodoktor Jul 29, 2026
376d528
Update2 260729
Mikrodoktor Jul 29, 2026
9f1e0f0
Update 3 260729
Mikrodoktor Jul 29, 2026
b0d6d48
Update README.md
Mikrodoktor Jul 29, 2026
7f53419
Update 4 260729
Mikrodoktor Jul 29, 2026
05ea6d6
Update 6 260729
Mikrodoktor Jul 29, 2026
1531655
Update 260730
Mikrodoktor Jul 30, 2026
15334a5
Update 260731
Mikrodoktor Jul 31, 2026
8ba3fc4
update 260803
Mikrodoktor Aug 3, 2026
f5110c6
Update 260807
Mikrodoktor Aug 7, 2026
3caf514
Update 260807
Mikrodoktor Aug 7, 2026
c70a39b
Merge branch 'master' into test/diataxis
ethanjli Aug 7, 2026
afa74d1
Fix broken links & filenames for Armin
ethanjli Aug 10, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Sample: Calibration target

In the picture below you see a properly focused and positioned structure of a calibration sample in the *live view* app. The actual structure used for the procedure will be the upper right hand corner of the 4x4 square (marked with a red arrow).

`Note` This structure is positioned in the lower left hand corner of the live view image due to the range of movements performed later in the calibration process.
`Note` This structure is positioned in the lower right hand corner of the live view image due to the range of movements performed later in the calibration process.

![20x-Pixel-Calibration-start-arrow](./20x-Pixel-Calibration-start-arrow.png)

After switching to the *FRAME settings* app and the tab *Manual pixel calibration*, please, follow the *Four-point calibration Workflow*. Click on *Backlash compensation X*. This moves the sample in X by the depicted amount in the same direction, as it will be moved in the following calibration step (e.g. 50um). This ensures that any backlash from the X-axis is eliminated prior to the following calibration step.
After switching to the *FRAME settings* app and the tab *Manual pixel calibration*, please, follow the *Four-point calibration Workflow*. Click on *Backlash compensation X*. This moves the sample in X by the depicted amount in the same direction, as it will be moved in the following calibration step (e.g. 50um). This ensures that any backlash from the X-axis is eliminated prior to the following calibration step (see [axis-backlash](../axis-backlash/README.md)) for more information on Axis backlash).

The next step is *Mark feature (P1 before X move)*. Click on the structure of your choice (here the corner) and a green cross-hair A1 will appear. Then click *Move stage in X* and the stage will be moved by the depicted amount in X (e.g. 100um). Make sure travel range does not exceed the live view window (structure not visible anymore). Then click *Mark same feature (P2 after X move)*. A second green cross-hair A2 and a line will appear. At the bottom of the image you will also see Pixel information for point A1 and A2 including the delta and the subsampling rate.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Stage calibration is recommended if you notice, that when navigating to specific

## Calibration Workflow

Choose a sample slide for calibr
Put the *openUC2 Pinhole Slide* in Slot 1 of the 4x sample holder. For stage calibration the pinhole *0.6/0.3mm* in the center of the slide will be used. It is designwise in the center of the slide, so it does not matter whether the sample is rotated or flipped. The distance from this middle pinhole to the edges of the probe is known and stored as reference value in *Imswitch*.

![openuc2-pinhole-slide](./openuc2-pinhole-slide.jpeg)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 27 additions & 20 deletions docs/usage/pro/frame/guides/day-2/controller/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,42 @@
---
sidebar_label: Game controller
sidebar_label: Controller
sidebar_position: 60
---

# Using the game controller to move the stage

:::note Draft outline
Scaffold. Replace the bullet prompts with your own text and delete this banner when done.
:::
This documentation guides you through specifics on "How to pair your controller with your FRAME?" and "How to use the controller?".

*How-to, for operators.* Pair and use a PS4/Bluetooth controller to jog the stage.
## Gamepad Concept

For a description of all buttons and joysticks see the picture below.

![controller-gamepad-description](./controller-gamepad-description.jpeg)

## Pair the controller

- Put the controller in pairing mode; connect via Bluetooth.
First, make sure that the controller is sufficiently charged. To charge it use the USB3 input and the included cable.

![Controller-charging](./Controller-charging.jpeg)

Put the controller in pairing mode by first pressing and holding the *Share/Turbo* button and then pressing the *home* button until the light bar starts blinking.

![Bluetooth controller pairing](./controller-bluetooth-pairing.png)

In ImSwitch go to *settings* and select *Updates* from the dropdown menu. This brings you to the *ImSwitch UI - SystemUpate* page.

![ImSwitch-settings-bluetooth-pairing](./ImSwitch-settings-bluetooth-pairing.png)

Toggle the button *Enable UC2 hardware control* to on. The button *Bluetooth Pairing* becomes now available (blue). Click the button and pairing starts.

![Bluetooth controller pairing](./IMAGES/bluetooth-pairing.png)
*Pairing via ImSwitch → Hardware Settings → System Update → "Bluetooth pairing"
(from FAT #0007 Part 2).*
![ImSwitch-settings-bluetooth-pairing2](./ImSwitch-settings-bluetooth-pairing2.png)

:::note TODO
Reused from Notion `FAT FRAME #0007 Korea - Part 2`. More pairing screenshots
(`grafik 1..25.png`) are in that folder if you want a step sequence.
:::
After succesful pairing the light bar of the *game controller* stops blinking and looks like in the below picture.

## Control mapping
![controller-paired](./controller-paired.jpeg)

- Which sticks/buttons move X/Y/Z, change speed, trigger capture.
- Note the axis-direction convention.
## Use the controller

:::note TODO
Notion source: `FAT FRAME #0007 Korea - part 7`/`Part 8` ("PS4 Controller direction").
Reference: [coordinates and axes](../../../reference/coordinates-and-axes/README.md).
:::
Use the joystick R3 to move X and Y axis.
Use the joystick R4 to move coarse Z.
Use the L2 and R2 button to move fine Z.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 9 additions & 9 deletions docs/usage/pro/frame/tutorials/day-1/first-sample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ As we can see above, first one shorter edge of the microscope slide is placed ag
Now you can let go of the spring-loaded edge:
![slide holder: let go of spring-loaded edge](./slide-holder-insert-let-go.jpg)

Now that we've inserted your first sample on a microscope slide, we can continue to the tutorial section to [position your sample for imaging](#position-and-properly-view-your-first-sample).
Now that we've inserted your first sample on a microscope slide, we can continue to the tutorial section to [Open the ImSwitch Live View App](#open-the-imswitch-live-view-app).

### Inserting a well plate

Expand All @@ -44,7 +44,7 @@ Take a well plate with a sample and place its A1 corner into the corner with the
| ------------------------------ | --------------------------- |
| ![well-plate holder: insert into corner with button](./well-plate-holder-insert-button.jpg) | ![well-plate holder: insert into opposite corner](./well-plate-holder-insert-opposite-corner.jpg) |

Now that we've inserted your first sample on a well plate, we can continue to the tutorial section to [position your sample for imaging](#position-and-properly-view-your-first-sample).
Now that we've inserted your first sample on a well plate, we can continue to the tutorial section to [Open the ImSwitch Live View App](#open-the-imswitch-live-view-app).

## Open the ImSwitch Live View App

Expand All @@ -56,7 +56,7 @@ Once you open the Live View page, it will look something like this:

![Live-view-ImSwitch-1-Streamoff](./Live-view-ImSwitch-1-Streamoff.png)

This preview stream was not yet started, so the indicator in the upper right corner is grey and says "Paused)". To start the stream click on the green *Start* button below the image.
The preview stream was not yet started, so the indicator in the upper right corner is grey and says "Paused". To start the stream click on the green *Start* button below the image.
An image will appear and the indicator changes to red saying "LIVE - 8.0 FPS" which indicates that the preview is a live preview with a frame rate of 8 FPS (Please, note, that in the picture below illumination is already turned on and the sample is in focus).

![Live-view-ImSwitch-2-streamon](./Live-view-ImSwitch-2-streamon.png)
Expand All @@ -76,7 +76,7 @@ Now we'll adjust all necessary parameters to position and properly view your sam
### Turn on illumination

First, we'll need to illuminate the sample.
In the right column of the *Live View* App, which has the *Stage Control* and *Autofocus* sections, scroll down to the "Illumination" section. Depending on your customer specific configuration you will see all illumination sources available to you - *LED* is always available. On default all illumination sources are switched off - to switch the *LED* on toggle the button on the right to *On*. Then set the LED Power by either sliding the scale or type in a value between 0 and 1023 to the right of the sliding scale.
In the right column of the *Live View* App, which has the *Stage Control* and *Autofocus* sections, scroll down to the "Illumination" section. Depending on your customer specific configuration you will see all illumination sources available to you - *LED* is always available. On default all illumination sources are switched off - to switch the *LED* on toggle the button on the right to *On*. Then set the LED Power by either sliding the scale bar or type in a value between 0 and 1023 to the right of the sliding scale.

![Live-View-ImSwitch-4-LEDonly](./Live-View-ImSwitch-4-LEDonly.png)

Expand Down Expand Up @@ -156,30 +156,30 @@ For more information, please refer to the [Preview Image Settings](../../../guid

## Save Streaming Presets

Now that you have done all the work to find the best parameters for an optimum *live view image* with the active camera and objective, we recommend saving all these parameters as a *Stream Preset*. This allows you to (re)load these settings at any point in time, e.g. after switching cameras or objectives which typically need other settings.
Now that you have done all the work to find the best parameters for an optimum *live view image* with the active camera and objective, we recommend saving all these parameters as a *Stream Preset*. This allows you to (re)load these settings at any point in time, e.g. after switching cameras or objectives which typically needs other settings.

You can find the *Stream Presets* section in the main column of the *Live View* App underneath the preview window. If you have not yet saved any preset it will look like the picture below.

![Stream-Presets](./Stream-Presets.png)

Press *Save Current* and a pop-up window opens. It will show you all current parameters saved in this particular *Stream Preset*, asks you to enter a *Preset name* and gives you some Checkbox options on what or what not to include in saved parameter set (on default all boxes are ticked).
Press *Save Current* and a pop-up window opens. It will show you all current parameters saved in this particular *Stream Preset*, asks you to enter a *Preset name* and gives you some Checkbox options on what or what not to include in the saved parameter set (on default all boxes are ticked).

![Stream-presets-popup](./Stream-presets-popup.png)

Press *Save* and the *Stream Preset* section will now show that there is 1 saved preset available. To apply a saved *Stream preset*, select the preset in the dropdown menu and click *Apply*. You can also edit and delete it here.

![Stream-Presets-saved](./Stream-Presets-saved.png)

`Important`These settings are stored in your browser´s cache. If you switch browsers or computers they will not be available anymore (redo).
`Important`These settings are stored in your browser´s cache. If you switch browsers or computers they will not be available anymore (You will then need to redo the procedure).

## Save and view your first image

To save your first image of your sample, go to the "Capture" panel below the camera stream:

![Capture-Section](./Capture-Section.png)

Enter a brief name for the image in the *Description* textbox, select your preferred file format (default TIFF) and press
- *Snap*: this stores the image on the SD card of the machines RPI. You can access it by either clicking *Go to folder* or switch to the *File Manager* App located in the ImSwitch Navigation bar on the left. Either way you will see something like in the picture below. To see the recorded image go to the folder *Recordings* and the subfolder with the current date and you will find your image. Double click on the image file and you will get a preview within ImSwitch.
Enter a brief name for the image in the *Description* textbox, select your preferred file format (default TIFF) and press either:
- *Snap*: this stores the image on the SD card of the machines RPI. You can access it by either clicking *Go to folder* or switch to the *File Manager* App located in the ImSwitch Navigation sidebar. Either way you will see something like in the picture below. To see the recorded image go to the folder *Recordings* and the subfolder with the current date and you will find your image. Double click on the image file and you will get a preview within ImSwitch.

![File-manager](./File-manager.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ To see the current calibration you have two options.

![Objective-Pos2-Live-View](./Objective-Pos2-Live-View.png)

*Option 2:* In the App sidebar menu on the right go to the App *FRAME Settings* (how to enable this app see ). Choose the tab *Objective Controller*. The settings for both objectives including Pixel Size are displayed at the top.
*Option 2:* In the App navigation sidebar on the left go to the App *FRAME Settings* (how to enable this app see ). Choose the tab *Objective Controller*. The settings for both objectives including Pixel Size are displayed at the top.

![Im-Switch-App-Sidebar](./Im-Switch-App-Sidebar.png)

Expand Down
Loading