Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 @@ -6,6 +6,7 @@ sidebar_label: First Connection
# Establish Your First Connection to the FRAME

In this tutorial, we will connect to your FRAME machine and open ImSwitch for the first time, so that you know how to access the software on your FRAME machine.
Along the way, we will encounter the FRAME's landing page for its web browser apps.

## Turn on the FRAME

Expand Down Expand Up @@ -120,4 +121,6 @@ The link will open ImSwitch in a new tab, and you will see something like this:

This screenshot shows ImSwitch's "Live View" page, which is a general-purpose interface for previewing the FRAME's camera, adjusting its camera settings, and moving the FRAME's sample stage.

## What's next

Now that you know how to access ImSwitch on your FRAME machine, you're ready to use ImSwitch to [check your FRAME's operational readiness](../operational-readiness/README.md) in our next tutorial!
30 changes: 17 additions & 13 deletions docs/usage/pro/frame/tutorials/day-1/first-sample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 40
Now that you've [confirmed that your FRAME was not damaged during shipping](../operational-readiness/README.md), we're ready to view microscopic samples with your FRAME.

In this tutorial, we will preview, save, and view our first images of a microscopy sample.
Along the way, we will see how to adjust imaging settings in ImSwitch's Live View app.
Along the way, we will use the FRAME's ImSwitch app for microscopy, and we will see how to adjust imaging settings in ImSwitch's Live View page.

## Open the live viewer

Expand All @@ -17,7 +17,7 @@ We can also open the Live View page from other pages in ImSwitch by clicking on

Once you open the Live View page, it will look something like this:

![ImSwitch app: Live View app](./imswitch-live-view.png)
![ImSwitch app: Live View page](./imswitch-live-view.png)

In the center of the above screenshot, under the "WIDEFIELDCAMERA" tab, we can see a preview camera stream from your FRAME's main camera.
This preview stream has red indicator (which says "LIVE - 16.0 FPS" in the above screenshot) in its upper-right corner which indicates whether the preview is a live preview, as well as the framerate of the preview stream.
Expand All @@ -34,35 +34,35 @@ TODO: how should the customer reposition the sample so that the sample will be i

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

![ImSwitch app: Live View app: Capture panel](./imswitch-live-view-capture.png)
![ImSwitch app: Live View page: Capture panel](./imswitch-live-view-capture.png)

Enter a brief name for the image in the "Description" textbox:

![ImSwitch app: Live View app: Capture panel: Description](./imswitch-live-view-capture-description.png)
![ImSwitch app: Live View page: Capture panel: Description](./imswitch-live-view-capture-description.png)

Then press the "Snap" button to save the image to the FRAME's internal storage.

## View your first image

To view the image you just saved, press the "Go to Folder" button:

![ImSwitch app: Live View app: Capture panel: Go to Folder button](./imswitch-live-view-capture-go-to-folder.png)
![ImSwitch app: Live View page: Capture panel: Go to Folder button](./imswitch-live-view-capture-go-to-folder.png)

This will display the image file in ImSwitch's File Manager app:
This will display the image file in ImSwitch's File Manager page:

![ImSwitch app: File Manager app](./imswitch-file-manager.png)
![ImSwitch app: File Manager page](./imswitch-file-manager.png)

We can see in the above screenshot that the image filename begins with the timestamp `2026-03-17T12-39-33-019192` (i.e. March 17, 2026 at 12:39), while the "Modified" timestamp is `3/17/2026 1:39 PM` (i.e. March 17, 2026 at 13:39).
The reason for this one-hour difference is that the timestamp in the image filename is always specified in the [UTC timezone](https://en.wikipedia.org/wiki/Coordinated_Universal_Time), while the "Modified" timestamp is always displayed in the local timezone of your web browser (which for the above screenshot is Central European Time, which is UTC+1).

Now we can right-click on the image to open a menu with entries to download the image or to preview it in ImSwitch:

![ImSwitch app: File Manager app: context menu: preview with ImJoy](./imswitch-file-manager-imjoy.png)
![ImSwitch app: File Manager page: context menu: preview with ImJoy](./imswitch-file-manager-imjoy.png)

This will open ImSwitch's ImJoy app.
This will open ImSwitch's ImJoy page.
After several moments, ImJoy will finish loading and open a window with a preview of the image we had saved:

![ImSwitch app: ImJoy app](./imswitch-imjoy.png)
![ImSwitch app: ImJoy page](./imswitch-imjoy.png)

## Download your first image

Expand All @@ -71,11 +71,11 @@ Now that we've previewed your first image, let's return to the File Manager to d
Click on the "File Manager" entry in the navbar.
This will return us to the file we had previously selected:

![ImSwitch app: File Manager app: context menu: nav](./imswitch-file-manager-nav.png)
![ImSwitch app: File Manager page: context menu: nav](./imswitch-file-manager-nav.png)

Now right-click on the image again, and click on the context menu's entry to download the image:

![ImSwitch app: File Manager app: context menu: download](./imswitch-file-manager-download.png)
![ImSwitch app: File Manager page: context menu: download](./imswitch-file-manager-download.png)

This will open your web browser's dialogue choose a location on your computer for downloading the image.

Expand All @@ -92,4 +92,8 @@ To learn how to do this, please refer to our [day-2 tutorial](../../day-2/acquir

:::

Now that we've acquired, previewed, and downloaded our first image, we're ready to learn how to [set up your FRAME to be able to get remote assistance from openUC2 customer support](../remote-assistance/README.md), [acquire data more efficiently](../../day-2/acquire-data/README.md), [improve your FRAME's imaging settings for your particular sample](../../day-2/imswitch-settings/README.md), and [more](../../day-2/README.md)!
## What's next

Now that we've acquired, previewed, and downloaded our first image, we're ready to learn how to [set up your FRAME to be able to get remote assistance from openUC2 customer support](../remote-assistance/README.md).

In the [day-2 tutorials](../../day-2/README.md), we'll also learn how to [acquire data more efficiently](../../day-2/acquire-data/README.md), [improve your FRAME's imaging settings for your particular sample](../../day-2/imswitch-settings/README.md), and more!
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Operational Readiness
# Check Your FRAME's Operational Readiness

In this tutorial, we will perform some checks to ensure that your FRAME is ready to be operated as a microscope.
Along the way, we will see some basic troubleshooting procedures you can run if your FRAME behaves in way that you don't expect.
Along the way, we will use the FRAME's ImSwitch app and see some basic troubleshooting procedures we can run in ImSwitch if your FRAME behaves in way that you don't expect.

## Ensure correct ImSwitch hardware configuration

Expand Down Expand Up @@ -39,27 +39,31 @@ If you need to change the hardware configuration file, please refer to our [day-

In order to ensure that the FRAME's hardware wasn't damaged in the process of being shipped to you, we can perform an acceptance test procedure in ImSwitch to check for certain kinds of hardware problems.

To open ImSwitch's Acceptance Testing app, click on the "App Manager" entry in ImSwitch's navigation sidebar:
To open ImSwitch's Acceptance Testing page, click on the "App Manager" entry in ImSwitch's navigation sidebar:

![ImSwitch app: navigation menu: App Manager](./imswitch-nav-menu-app-manager.png)

On the App Manager page, click on the search box:

![ImSwitch app: App Manager app: search box](./imswitch-app-manager-search.png)
![ImSwitch app: App Manager page: search box](./imswitch-app-manager-search.png)

Type "test" to filter the apps, and then click the play button on the Acceptance Test app:

![ImSwitch app: App Manager app: Acceptance Test entry: play button](./imswitch-app-manager-acceptance-test-play.png)
![ImSwitch app: App Manager page: Acceptance Test entry: play button](./imswitch-app-manager-acceptance-test-play.png)

This will open the Acceptance Test app:
This will open the Acceptance Test page:

![ImSwitch app: Acceptance Test app](./imswitch-acceptance-test.png)
![ImSwitch app: Acceptance Test page](./imswitch-acceptance-test.png)

For each action (e.g. "Home X Axis") listed in the app, press the button to perform that action and then answer the question about the result of that action (e.g. "Did the stage successfully home?") by pressing the corresponding button (e.g. "Yes" or "No").
For each action (e.g. "Home X Axis") listed in the Acceptance Test page, press the button to perform that action and then answer the question about the result of that action (e.g. "Did the stage successfully home?") by pressing the corresponding button (e.g. "Yes" or "No").

At the end of the test sequence, a test report will be generated summarizing the results of the acceptance test procedure.
If any test failed on a FRAME which you purchased from openUC2, please download the test report and send it to openUC2 customer support at [support@openuc2.com](mailto:support@openuc2.com) so that we can identify and fix any damage to your machine which occurred while it was in the process of being shipped to you.

![ImSwitch app: Acceptance Test app: test report](./imswitch-acceptance-test-report.png)
![ImSwitch app: Acceptance Test page: test report](./imswitch-acceptance-test-report.png)

If all tests passed (like in the screenshot above), then your FRAME is ready for you to use it as a microscope for saving images of your [first sample](../first-sample/README.md)!
If all tests passed (like in the screenshot above), then your FRAME is ready for you to use it as a microscope.

## What's next

Now that we've determined that your FRAME is ready for imaging operations, we'll save images of your [first sample](../first-sample/README.md)!
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Remote Assistance
# Set Up Remote Assistance on Your FRAME

In this tutorial, we will set up remote assistance on your FRAME machine, so that you know how to enable remote assistance when you need help from openUC2 customer support.
Along the way, we will encounter the FRAME's Machine Administration app and see how to use it to adjust various settings in the FRAME's embedded Raspberry Pi computer.

## Connect your FRAME to the internet via Wi-Fi

Expand Down Expand Up @@ -135,3 +136,8 @@ Then the Remote Access page will look like this:

Note how the status is reported as "stopped" and connectivity is reported as "disconnected".
As described above, you can re-enable remote assistance from this state simply by clicking the blue "Enable" button.

## What's next

Now that we know how to make your FRAME machine available for remote assistance from openUC2 customer support, we're almost done with the day-1 tutorials!
Next, we'll learn about how to [safely shut down](../shutdown/README.md) your FRAME machine in a way that prevents data corruption of the data you acquire on your FRAME.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions docs/usage/pro/frame/tutorials/day-1/shutdown/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
sidebar_position: 60
---

# Safe Shutdown

In this tutorial, we will shut down your FRAME machine without causing data corruption on your FRAME when unplugging it from power.

## Shut down the operating system

First, let's open the FRAME's landing page in your web browser (we learned how to do this [in the First Connection tutorial](../first-connection/README.md#open-the-frames-web-browser-landing-page)):

![Machine Admin app homepage](./machine-admin-home.png)

In the screenshot above, we can see three buttons: "Soft reboot", "Full reboot", and "Shut down".
These buttons allow you to reboot or shut down the operating system which is running on your FRAME's RPi computer; the operating system, called "[openUC2 OS](../../../../../components/os/README.md)", is responsible for:

- running all software on your FRAME
- managing your FRAME's data storage devices and network interfaces

Now press the "Shut down" button to shut down the operating system.
When you do this, the operating system will:

- finish writing and saving any files it was in the middle of creating/modifying, to avoid data loss or data corruption
- clean up after itself

This shutdown process will usually be complete within 30 seconds.
Afterwards, it will be safe to unplug power from your FRAME.

## Unplug power

Now we will fully cut off power by unplugging the power adapter from the FRAME's power jack, which we had previously seen in the [first connection tutorial](../first-connection/README.md#turn-on-the-frame).
Remove the power adapter's plug from the FRAME's power jack:

| Before | After |
| ------ | ----- |
| ![plugged](plugged.jpeg) | ![unplugged](unplugged.jpeg) |

## Turn on the FRAME again

Now we'll turn on the FRAME again, since you'll need it to be powered on for the [day-2 tutorials](../../day-2/README.md).

Plug in power to your FRAME and watch the statuses of its indicator LED, in the same way as we learned in the [first connection tutorial](../first-connection/README.md#turn-on-the-frame).

## What's next

Congratulations!
We've finished the day-1 tutorials for learning about the basics of how to set up and operate your FRAME.

Now we're ready to continue to the [day-2 tutorials](../../day-2/README.md) to learn how to perform various routine tasks with the FRAME, including more efficient ways to [acquire data](../../day-2/acquire-data/README.md) on the FRAME.
1 change: 1 addition & 0 deletions docs/usage/pro/frame/tutorials/day-1/shutdown/plugged.jpeg
1 change: 1 addition & 0 deletions docs/usage/pro/frame/tutorials/day-1/shutdown/rear.jpeg
Loading