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
3 changes: 2 additions & 1 deletion docs/usage/disc/qbox/09_ODMR/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ ODMR combines optical spectroscopy with magnetic resonance to detect spin transi
| Firmware (flash in Chrome/Edge, category **qBOX (ODMR)**) | [openUC2 web flasher](https://youseetoo.github.io/) |
| Control app, computer (USB, Chrome/Edge) | [youseetoo.github.io/odmr](https://youseetoo.github.io/odmr) |
| Control app, Android (USB-C OTG, **ODMR** tab) | [UC2 Control APK](https://github.com/youseetoo/UC2Control/releases/latest) |
| Control without a cable | the board's own WiFi, `http://192.168.4.1` |
| Control app, iPad/iPhone (USB-C, XIAO ESP32-S3) | the board appears as a wired network: `http://192.168.7.1` in Safari |
| Control without a cable | the board's own WiFi, `http://192.168.4.1` — **off by default**, switch it on in the app (📶); with WiFi on, the CE assessment no longer applies |
| Source code, serial protocol | [ODMR_Server](https://github.com/openUC2/TechnicalDocs-openUC2-QBox/tree/main/Production_Files/Software/ODMR_Server) |

Step-by-step: section 2.2–2.3 of the ODMR tutorial.
Expand Down
39 changes: 27 additions & 12 deletions docs/usage/disc/qbox/09_ODMR/de/04_qBox_ODMR_GER_neu.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,11 +229,11 @@ Dies ist eine empfohlene Schritt-für-Schritt-Anleitung zum Aufbau des ODMR-Setu

1. Verbinden Sie den ESP32 auf der ODMR-Platine über das USB-C-Kabel mit Ihrem Computer.

2. Stellen Sie sicher, dass Ihr ESP32-Board über die neueste Firmware verfügt. Öffnen Sie den [openUC2-Webflasher](https://youseetoo.github.io/) in **Chrome** oder **Edge** auf einem Computer, wählen Sie die Kategorie **qBOX (ODMR)** und Ihr Board (höchstwahrscheinlich **ODMR server (XIAO ESP32-C3)**) und klicken Sie dann auf die Schaltfläche „Verbinden“.
2. Stellen Sie sicher, dass Ihr ESP32-Board über die neueste Firmware verfügt. Öffnen Sie den [openUC2-Webflasher](https://youseetoo.github.io/) in **Chrome** oder **Edge** auf einem Computer, wählen Sie die Kategorie **qBOX (ODMR)** und Ihr Board (**ODMR Xiao ESP32C3** oder **ODMR Xiao ESP32S3**, steht auf der kleinen Platine) und klicken Sie dann auf die Schaltfläche „Verbinden“.

Den Quellcode finden Sie [hier](https://github.com/openUC2/TechnicalDocs-openUC2-QBox/tree/main/Production_Files/Software/ODMR_Server).

3. Im Browser werden Sie in einem Dialogfeld aufgefordert, den seriellen Port Ihres ESP32 auszuwählen. Der XIAO nutzt seinen eingebauten USB-Anschluss und erscheint daher als „USB JTAG/serial debug unit“ (Windows: „USB-Serielles Gerät (COMx)“, macOS: „cu.usbmodem…“) – ein Treiber ist nicht nötig. Sobald die Verbindung hergestellt ist, installieren Sie die neueste Firmware mit einem Klick auf „Installieren“. Die Firmware enthält auch die Webseiten des Boards.
3. Im Browser werden Sie in einem Dialogfeld aufgefordert, den seriellen Port Ihres ESP32 auszuwählen. Der XIAO nutzt seinen eingebauten USB-Anschluss und erscheint daher als „USB JTAG/serial debug unit“ (Windows: „USB-Serielles Gerät (COMx)“, macOS: „cu.usbmodem…“) – ein Treiber ist nicht nötig. Sobald die Verbindung hergestellt ist, installieren Sie die neueste Firmware mit einem Klick auf „Installieren“. Die Firmware enthält die Steuer-App, das Board liefert sie also selbst aus.

4. Warten Sie, bis die Firmware erfolgreich geflasht wurde.

Expand All @@ -248,20 +248,35 @@ Dies ist eine empfohlene Schritt-für-Schritt-Anleitung zum Aufbau des ODMR-Setu
/>
</div>

### 2.3: Web‑Interface verbinden
### 2.3: Steuer-App verbinden

Nach dem Flashen der Firmware ziehen Sie den Stecker des ESP ab und stecken ihn wieder ein. Es gibt drei Wege, das Experiment zu steuern – alle bieten dieselben Messungen:
Nach dem Flashen der Firmware ziehen Sie den Stecker des ESP ab und stecken ihn wieder ein. Auf allen unten genannten Wegen läuft dieselbe Steuer-App – gleiche Reiter, gleiche Messungen: *Anleitung* (16 animierte Schritte zum Aufbau und zur Justage, bei den Justageschritten mit Live-Signal), *Frequenz-Sweep*, *Live-Monitor*, *B-Field Monitor*, *Justage* und *Infos*. Vom Board geladen braucht sie kein Internet. Jedes Diagramm hat einen Knopf **↕ Auto**, der die y-Achse neu skaliert.

**A – USB am Computer (empfohlen):** Öffnen Sie https://youseetoo.github.io/odmr in Chrome oder Edge, klicken Sie auf **Gerät verbinden** und wählen Sie den Port des ESP32 (115200 Baud). Reiter: *Frequenz-Sweep*, *Live-Monitor*, *B-Field Monitor*, *Justage* (mit Schritt-für-Schritt-Anleitung) und *Infos*. Sweeps lassen sich überlagern, als CSV oder PNG speichern und teilen.
**A – USB am Computer (empfohlen):** Öffnen Sie https://youseetoo.github.io/odmr in Chrome oder Edge (oder nutzen Sie die unten eingebettete App), klicken Sie auf **Gerät verbinden** und wählen Sie den Port des ESP32 (115200 Baud). Sweeps lassen sich überlagern, als CSV oder PNG speichern und teilen.

**B – USB am Android-Smartphone oder -Tablet:** Installieren Sie die App **UC2 Control** ([APK herunterladen](https://github.com/youseetoo/UC2Control/releases/latest) und die Installation erlauben), verbinden Sie den ESP32 mit einem USB-C-(OTG-)Kabel, erlauben Sie den USB-Zugriff, wenn Android fragt, und öffnen Sie den Reiter **ODMR**. Der Reiter bietet dieselben Messungen wie A (Sweep, Live, B-Feld, Justage mit Anleitung); Diagramme lassen sich mit zwei Fingern zoomen, ein Tipp zeigt den Messwert; CSV- und PNG-Dateien landen in `Download/UC2 ODMR/` und können direkt geteilt werden (E-Mail, Cloud, Messenger). Chrome auf Android unterstützt kein Web Serial, dort also die App verwenden.
**B – USB am iPad / iPhone (nur XIAO ESP32-S3):** Verbinden Sie das Board mit einem USB-C-Kabel. Es erscheint als kabelgebundenes Netzwerk; öffnen Sie http://192.168.7.1 in Safari. Das klappt auch an Computern, deren Browser kein Web Serial kann (Safari, Firefox). Das iPad behält seine eigene Internetverbindung.

**C – WLAN, beliebiges Gerät:** Warten Sie, bis das Gerät sein eigenes WLAN-Netzwerk erstellt.
Klicken Sie auf das WLAN-/Netzwerksymbol in der unteren rechten Ecke Ihres Bildschirms (wo Sie normalerweise Ihr WLAN auswählen).
- Nach einigen Sekunden sollte ein neues Netzwerk mit einem Namen wie „ODMR-XXXX“ in der Liste erscheinen.
- Wählen Sie dieses Netzwerk aus, um eine Verbindung zum Gerät herzustellen.
- Sobald die Verbindung hergestellt ist, öffnen Sie Ihren Browser und gehen Sie zu http://192.168.4.1
- Auf der Website gehen Sie zu „Messung(Device)“.
**C – USB am Android-Smartphone oder -Tablet:** Installieren Sie die App **UC2 Control** ([APK herunterladen](https://github.com/youseetoo/UC2Control/releases/latest) und die Installation erlauben), verbinden Sie den ESP32 mit einem USB-C-(OTG-)Kabel, erlauben Sie den USB-Zugriff, wenn Android fragt, und öffnen Sie den Reiter **ODMR**. Er bietet dieselben Messungen (Sweep, Live, B-Feld, Justage mit Anleitung); Diagramme lassen sich mit zwei Fingern zoomen, ein Tipp zeigt den Messwert; CSV- und PNG-Dateien landen in `Download/UC2 ODMR/` und können direkt geteilt werden (E-Mail, Cloud, Messenger). Chrome auf Android unterstützt kein Web Serial, dort also die App verwenden.

**D – WLAN, beliebiges Gerät (ab Werk aus):** Der Funk des Boards ist bei Auslieferung ausgeschaltet.

:::warning
Das Gerät ist mit ausgeschaltetem Funk CE-konform. Mit eingeschaltetem WLAN gilt diese Konformitätsbewertung nicht mehr – Betrieb auf eigene Verantwortung.
:::

- Zum Einschalten einmal über A oder B verbinden, oben auf **📶 WLAN aus** klicken und bestätigen. Die Einstellung bleibt auch nach einem Neustart erhalten, bis Sie sie dort wieder ausschalten (serieller Befehl: `WIFI ON` / `WIFI OFF`).
- Mit dem Netzwerk `openUC2_ODMR_XXXXXX` verbinden (kein Passwort) und http://192.168.4.1 in einem beliebigen Browser öffnen.

#### Direkt hier ausprobieren

Board per USB anschließen und auf **Gerät verbinden** klicken (Chrome oder Edge am Computer):

<iframe
src="https://youseetoo.github.io/odmr/"
title="openUC2 ODMR control app"
allow="serial"
style={{width: '100%', height: '850px', border: '1px solid #ddd', borderRadius: '8px'}}
/>


### 2.4: Test im Web‑Interface
Expand Down
39 changes: 27 additions & 12 deletions docs/usage/disc/qbox/09_ODMR/en/04_qBox_ODMR_ENG.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,11 +245,11 @@ This is a suggested step-by-step guide on how to build the ODMR setup. You can d

1. Connect the ESP32 in the control box to your computer using the USB-C cable.

2. Make sure your ESP32 board has the latest firmware. Open the [openUC2 web flasher](https://youseetoo.github.io/) in **Chrome** or **Edge** on a computer, choose the category **qBOX (ODMR)** and your board (most likely **ODMR server (XIAO ESP32-C3)**), then click on the `connect` button.
2. Make sure your ESP32 board has the latest firmware. Open the [openUC2 web flasher](https://youseetoo.github.io/) in **Chrome** or **Edge** on a computer, choose the category **qBOX (ODMR)** and your board (**ODMR Xiao ESP32C3** or **ODMR Xiao ESP32S3**, printed on the small board), then click on the `connect` button.

The source code can be found [here](https://github.com/openUC2/TechnicalDocs-openUC2-QBox/tree/main/Production_Files/Software/ODMR_Server).

3. In your browser, a dialog will prompt you to select the serial port of your ESP32. The XIAO uses its built-in USB, so it shows up as `USB JTAG/serial debug unit` (Windows: `USB Serial Device (COMx)`, macOS: `cu.usbmodem…`) — no driver needed. Once connected, install the latest firmware by clicking the "Install" button. The firmware includes the board's own web pages.
3. In your browser, a dialog will prompt you to select the serial port of your ESP32. The XIAO uses its built-in USB, so it shows up as `USB JTAG/serial debug unit` (Windows: `USB Serial Device (COMx)`, macOS: `cu.usbmodem…`) — no driver needed. Once connected, install the latest firmware by clicking the "Install" button. The firmware includes the control app, so the board serves it itself.

4. Wait until the firmware has been successfully flashed.

Expand All @@ -264,20 +264,35 @@ This is a suggested step-by-step guide on how to build the ODMR setup. You can d
/>
</div>

### 2.3: Connecting to the Web Interface
### 2.3: Connecting to the Control App

After flashing, unplug and replug the ESP. There are three ways to control the experiment — they all offer the same measurements:
After flashing, unplug and replug the ESP. The same control app runs in every way listed below — same tabs, same measurements: *Guide* (16 animated steps for building and aligning the setup, with the live signal on the alignment steps), *Frequency Sweep*, *Live Monitor*, *B-Field Monitor*, *Alignment* and *Info*. Once on the board it needs no internet. Every plot has an **↕ Auto** button to rescale the y-axis.

**A — USB, computer (recommended):** open https://youseetoo.github.io/odmr in Chrome or Edge, click **Connect device** and pick the ESP32's port (115200 baud). Tabs: *Frequency Sweep*, *Live Monitor*, *B-Field Monitor*, *Alignment* (with a step-by-step tutorial) and *Info*. Sweeps can be overlaid, saved as CSV or PNG and shared.
**A — USB, computer (recommended):** open https://youseetoo.github.io/odmr in Chrome or Edge (or use the app embedded below), click **Connect device** and pick the ESP32's port (115200 baud). Sweeps can be overlaid, saved as CSV or PNG and shared.

**B — USB, Android phone or tablet:** install the **UC2 Control** app ([download the APK](https://github.com/youseetoo/UC2Control/releases/latest) and allow the installation), connect the ESP32 with a USB-C (OTG) cable, allow USB access when Android asks, and open the **ODMR** tab. It has the same measurements as A (sweep, live, B-field, alignment with tutorial); pinch the charts to zoom, tap a point for its value; CSV and PNG files are saved to `Download/UC2 ODMR/` and can be shared directly (e-mail, cloud, messenger). Chrome on Android cannot do Web Serial, so use the app there.
**B — USB, iPad / iPhone (XIAO ESP32-S3 only):** connect the board with a USB-C cable. It shows up as a wired network; open http://192.168.7.1 in Safari. This also works on computers whose browser has no Web Serial (Safari, Firefox). The iPad keeps its own internet connection.

**C — WiFi, any device:** wait until the device creates its own Wi-Fi network.
- Click on the Wi-Fi / network icon in the bottom right corner of your screen (where you normally select your Wi-Fi).
- After a few seconds, a new network called something like `ODMR-XXXX` should appear in the list.
- Select this network to connect to the device.
- Once connected, open your browser and go to http://192.168.4.1
- Once on the website go to ` Messung(Device)`).
**C — USB, Android phone or tablet:** install the **UC2 Control** app ([download the APK](https://github.com/youseetoo/UC2Control/releases/latest) and allow the installation), connect the ESP32 with a USB-C (OTG) cable, allow USB access when Android asks, and open the **ODMR** tab. It has the same measurements (sweep, live, B-field, alignment with tutorial); pinch the charts to zoom, tap a point for its value; CSV and PNG files are saved to `Download/UC2 ODMR/` and can be shared directly (e-mail, cloud, messenger). Chrome on Android cannot do Web Serial, so use the app there.

**D — WiFi, any device (off by default):** the board's radio is switched off when it is delivered.

:::warning
The device is CE compliant with its radio switched off. With WiFi switched on, that conformity assessment no longer applies — use it at your own responsibility.
:::

- To switch WiFi on, connect once via A or B and click **📶 WiFi off** in the top bar, then confirm. The setting is kept after a restart until you switch it off the same way (serial command: `WIFI ON` / `WIFI OFF`).
- Join the network `openUC2_ODMR_XXXXXX` (no password) and open http://192.168.4.1 in any browser.

#### Try it right here

Plug the board in via USB and click **Connect device** (Chrome or Edge on a computer):

<iframe
src="https://youseetoo.github.io/odmr/"
title="openUC2 ODMR control app"
allow="serial"
style={{width: '100%', height: '850px', border: '1px solid #ddd', borderRadius: '8px'}}
/>


### 2.4: Testing in the Web Interface
Expand Down
Loading