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
24 changes: 20 additions & 4 deletions android/robot/README.de-DE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,30 @@
Die App startet mit einem Menübildschirm, der alle verfügbaren Bildschirme anzeigt. Der Einstellungsbildschirm kann durch Klicken auf das Symbol in der oberen rechten Ecke geöffnet werden. Durch Klicken auf die anderen Symbole kann der Benutzer auf verschiedene Bildschirme zugreifen, deren Funktionen im Folgenden erklärt werden.

<p align="left">
<img style="padding-right: 2%;" src="../../docs/images/screen_main.png" alt="Hauptmenü" width="24.5%"/>
<img src="../../docs/images/screen_settings.png" alt="Einstellungsmenü" width="24.5%"/>
<img src="../../docs/images/dialog_stream_mode.png" alt="Einstellungsmenü" width="24.5%"/>
<img src="../../docs/images/dialog_connectivity_mode.png" alt="Einstellungsmenü" width="24.5%"/>
<img style="padding-right: 2%;" src="../../docs/images/screen_main.jpg" alt="Hauptmenü" height="300"/>
<img src="../../docs/images/screen_settings.jpg" alt="Einstellungsmenü" height="300"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="Einstellungsmenü" height="300"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="Einstellungsmenü" height="300"/>
</p>

### Einstellungsmenü

#### Mehrsprachige Unterstützung

Tippen Sie in der Kategorie „Allgemein“ auf `Sprache`, um die Anzeigesprache der App zu wählen. Wählen Sie `Systemstandard`, um die Sprache Ihres Telefons zu verwenden, oder eine der unterstützten Sprachen: English, Deutsch, Español, Français, 中文, 한국어 oder हिन्दी. Die App wendet die neue Sprache sofort an.

<p align="left">
<img src="../../docs/images/screen_language.jpg" alt="Sprachauswahl" height="300"/>
</p>

#### Web-Signalisierungsserver

Tippen Sie in der Kategorie „Web-Controller“ auf `Web-Signalisierungsserver`, um die WebSocket-Adresse des Signalisierungsservers einzugeben, zum Beispiel `ws://<server-ip>:8080/ws`. Sie wird verwendet, wenn der Steuerungsmodus auf Webserver eingestellt ist. Telefon und Server müssen sich dafür im selben WLAN befinden. Die Einrichtung ist im [Webserver](../../controller/web-server/README.md) beschrieben.

<p align="left">
<img src="../../docs/images/dialog_web_signaling_server.jpg" alt="Web-Signalisierungsserver" height="300"/>
</p>

#### USB-Verbindung

Tippen Sie auf das USB-Symbol, um die USB-Optionen zu öffnen. Das Dropdown-Menü wird verwendet, um die Baudrate einzustellen. Der Standardwert ist 115200 und Sie sollten dies nicht ändern müssen, es sei denn, Sie ändern die Arduino-Firmware. Die App versucht automatisch eine Verbindung herzustellen, aber falls Sie auf Probleme stoßen, können Sie diesen Schalter verwenden, um die Verbindung zu trennen/herzustellen.
Expand Down
24 changes: 20 additions & 4 deletions android/robot/README.es-ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,30 @@
La aplicación comienza con una pantalla de menú que muestra todas las pantallas disponibles. La pantalla de configuración se puede abrir con un clic en el ícono en la esquina superior derecha. Al hacer clic en los otros íconos, el usuario puede acceder a varias pantallas cuyas funcionalidades se explican a continuación.

<p align="left">
<img style="padding-right: 2%;" src="../../docs/images/screen_main.png" alt="Menú Principal" width="24.5%"/>
<img src="../../docs/images/screen_settings.png" alt="Menú de Configuración" width="24.5%"/>
<img src="../../docs/images/dialog_stream_mode.png" alt="Menú de Configuración" width="24.5%"/>
<img src="../../docs/images/dialog_connectivity_mode.png" alt="Menú de Configuración" width="24.5%"/>
<img style="padding-right: 2%;" src="../../docs/images/screen_main.jpg" alt="Menú Principal" height="300"/>
<img src="../../docs/images/screen_settings.jpg" alt="Menú de Configuración" height="300"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="Menú de Configuración" height="300"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="Menú de Configuración" height="300"/>
</p>

### Menú de Configuración

#### Soporte multilingüe

Toca `Idioma` en la categoría General para elegir el idioma de la app. Selecciona `Predeterminado del sistema` para usar el idioma de tu teléfono, o elige uno de los idiomas disponibles: English, Deutsch, Español, Français, 中文, 한국어 o हिन्दी. La app aplica el nuevo idioma al instante.

<p align="left">
<img src="../../docs/images/screen_language.jpg" alt="Selección de idioma" height="300"/>
</p>

#### Servidor de señalización web

Toca `Servidor de señalización web` en la categoría Controlador web para introducir la dirección WebSocket del servidor de señalización, por ejemplo `ws://<ip-del-servidor>:8080/ws`. Se usa cuando el modo de control es servidor web, por lo que el teléfono y el servidor deben estar en la misma red Wi-Fi. Consulta el [servidor web](../../controller/web-server/README.md) para ver cómo configurarlo.

<p align="left">
<img src="../../docs/images/dialog_web_signaling_server.jpg" alt="Servidor de señalización web" height="300"/>
</p>

#### Conexión USB

Toca el ícono USB para abrir las opciones USB. El menú desplegable se usa para configurar la velocidad en baudios. El valor predeterminado es 115200 y no deberías necesitar cambiarlo a menos que modifiques el firmware de Arduino. La aplicación intentará conectarse automáticamente, pero en caso de que encuentres problemas, puedes usar este interruptor para desconectar/conectar.
Expand Down
24 changes: 20 additions & 4 deletions android/robot/README.fr-FR.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,30 @@
L'application démarre avec un écran de menu qui affiche tous les écrans disponibles. L'écran des paramètres peut être ouvert en cliquant sur l'icône en haut à droite. En cliquant sur les autres icônes, l'utilisateur peut accéder à divers écrans dont les fonctionnalités sont expliquées ci-dessous.

<p align="left">
<img style="padding-right: 2%;" src="../../docs/images/screen_main.png" alt="Menu Principal" width="24.5%"/>
<img src="../../docs/images/screen_settings.png" alt="Menu Paramètres" width="24.5%"/>
<img src="../../docs/images/dialog_stream_mode.png" alt="Menu Paramètres" width="24.5%"/>
<img src="../../docs/images/dialog_connectivity_mode.png" alt="Menu Paramètres" width="24.5%"/>
<img style="padding-right: 2%;" src="../../docs/images/screen_main.jpg" alt="Menu Principal" height="300"/>
<img src="../../docs/images/screen_settings.jpg" alt="Menu Paramètres" height="300"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="Menu Paramètres" height="300"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="Menu Paramètres" height="300"/>
</p>

### Menu Paramètres

#### Prise en charge multilingue

Appuyez sur `Langue` dans la catégorie Général pour choisir la langue d'affichage de l'application. Sélectionnez `Par défaut du système` pour suivre la langue de votre téléphone, ou choisissez l'une des langues prises en charge : English, Deutsch, Español, Français, 中文, 한국어 ou हिन्दी. L'application applique la nouvelle langue immédiatement.

<p align="left">
<img src="../../docs/images/screen_language.jpg" alt="Sélection de la langue" height="300"/>
</p>

#### Serveur de signalisation web

Appuyez sur `Serveur de signalisation web` dans la catégorie Contrôleur web pour saisir l'adresse WebSocket du serveur de signalisation, par exemple `ws://<ip-du-serveur>:8080/ws`. Elle est utilisée lorsque le mode de contrôle est réglé sur serveur web ; le téléphone et le serveur doivent donc être sur le même réseau Wi-Fi. Consultez le [serveur web](../../controller/web-server/README.md) pour sa configuration.

<p align="left">
<img src="../../docs/images/dialog_web_signaling_server.jpg" alt="Serveur de signalisation web" height="300"/>
</p>

#### Connexion USB

Appuyez sur l'icône USB pour ouvrir les options USB. Le menu déroulant est utilisé pour définir le débit en bauds. La valeur par défaut est 115200 et vous ne devriez pas avoir besoin de la changer à moins de modifier le firmware Arduino. L'application tentera de se connecter automatiquement, mais en cas de problème, vous pouvez utiliser cet interrupteur pour déconnecter/connecter.
Expand Down
24 changes: 20 additions & 4 deletions android/robot/README.ko-KR.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,30 @@
앱은 모든 사용 가능한 화면을 보여주는 메뉴 화면으로 시작돼요. 설정 화면은 오른쪽 상단 모서리에 있는 아이콘을 클릭하면 열 수 있어요. 다른 아이콘을 클릭하면 여러 가지 화면에 접근할 수 있고, 각 화면의 기능은 아래에서 설명할게요.

<p align="left">
<img src="../../docs/images/screen_main.jpg" alt="Main Menu" width="21.6%"/>
<img src="../../docs/images/screen_settings.jpg" alt="Settings Menu" width="20%"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="Settings Menu" width="20%"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="Settings Menu" width="20%"/>
<img src="../../docs/images/screen_main.jpg" alt="Main Menu" height="300"/>
<img src="../../docs/images/screen_settings.jpg" alt="Settings Menu" height="300"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="Settings Menu" height="300"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="Settings Menu" height="300"/>
</p>

### 설정 메뉴

#### 다국어 지원

일반 카테고리에서 `언어`를 탭하면 앱 표시 언어를 선택할 수 있어요. `시스템 기본값`을 선택하면 휴대폰 언어를 따르고, 지원하는 언어(English, Deutsch, Español, Français, 中文, 한국어, हिन्दी) 중에서 직접 고를 수도 있어요. 선택한 언어는 바로 적용돼요.

<p align="left">
<img src="../../docs/images/screen_language.jpg" alt="Language Selection" height="300"/>
</p>

#### 웹 시그널링 서버

웹 컨트롤러 카테고리에서 `웹 시그널링 서버`를 탭하고 시그널링 서버의 WebSocket 주소를 입력하세요. 예: `ws://<서버-IP>:8080/ws`. 제어 모드를 웹 서버로 설정했을 때 사용하며, 휴대폰과 서버가 같은 Wi-Fi 네트워크에 있어야 해요. 설정 방법은 [웹 서버](../../controller/web-server/README.md)를 참고하세요.

<p align="left">
<img src="../../docs/images/dialog_web_signaling_server.jpg" alt="Web Signaling Server" height="300"/>
</p>

#### USB 연결

USB 아이콘을 탭하면 USB 옵션이 열려요. 드롭다운 메뉴는 전송 속도를 설정하는 데 사용돼요. 기본값은 115200이며, Arduino 펌웨어를 만지지 않는 한 이 값은 변경할 필요가 없어요. 앱은 자동으로 연결을 시도하지만, 문제가 생기면 이 스위치를 사용해 연결을 끊거나 다시 연결할 수 있어요.
Expand Down
24 changes: 20 additions & 4 deletions android/robot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,30 @@
The app starts with a menu screen that shows all available screens. The settings screen can be opened with a click on the icon at the top right corner. By clicking on the other icons the user can access various screens whose functionalities are explained in the following.

<p align="left">
<img src="../../docs/images/screen_main.jpg" alt="Main Menu" width="21.6%"/>
<img src="../../docs/images/screen_settings.jpg" alt="Settings Menu" width="20%"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="Settings Menu" width="20%"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="Settings Menu" width="20%"/>
<img src="../../docs/images/screen_main.jpg" alt="Main Menu" height="300"/>
<img src="../../docs/images/screen_settings.jpg" alt="Settings Menu" height="300"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="Settings Menu" height="300"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="Settings Menu" height="300"/>
</p>

### Settings Menu

#### Multi-Language Support

Tap `Language` in the General category to choose the display language of the app. Select `System Default` to follow the language of your phone, or pick one of the supported languages: English, Deutsch, Español, Français, 中文, 한국어 or हिन्दी. The app applies the new language right away.

<p align="left">
<img src="../../docs/images/screen_language.jpg" alt="Language Selection" height="300"/>
</p>

#### Web Signaling Server

Tap `Web Signaling Server` in the Web Controller category to enter the WebSocket address of the signaling server, for example `ws://<server-ip>:8080/ws`. It is used when the control mode is set to web server, so your phone and the server need to be on the same Wi-Fi network. See the [web server](../../controller/web-server/README.md) for how to set it up.

<p align="left">
<img src="../../docs/images/dialog_web_signaling_server.jpg" alt="Web Signaling Server" height="300"/>
</p>

#### USB Connection

Tap the USB icon to open the USB options. The drop-down menu is used to set the baud rate. The default is 115200, and you should not need to change this unless you mess with the Arduino firmware. The app will attempt to connect automatically, but in case you encounter issues you can use this switch to disconnect/connect.
Expand Down
24 changes: 20 additions & 4 deletions android/robot/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,30 @@
应用程序启动时会显示一个菜单屏幕,列出所有可用的屏幕。可以通过点击右上角的图标打开设置屏幕。点击其他图标,用户可以访问各种屏幕,其功能在下文中解释。

<p align="left">
<img style="padding-right: 2%;" src="../../docs/images/screen_main.png" alt="主菜单" width="24.5%"/>
<img src="../../docs/images/screen_settings.png" alt="设置菜单" width="24.5%"/>
<img src="../../docs/images/dialog_stream_mode.png" alt="设置菜单" width="24.5%"/>
<img src="../../docs/images/dialog_connectivity_mode.png" alt="设置菜单" width="24.5%"/>
<img style="padding-right: 2%;" src="../../docs/images/screen_main.jpg" alt="主菜单" height="300"/>
<img src="../../docs/images/screen_settings.jpg" alt="设置菜单" height="300"/>
<img src="../../docs/images/dialog_stream_mode.jpg" alt="设置菜单" height="300"/>
<img src="../../docs/images/dialog_connectivity_mode.jpg" alt="设置菜单" height="300"/>
</p>

### 设置菜单

#### 多语言支持

在“常规”类别中点击`语言`,即可选择应用的显示语言。选择`系统默认`会跟随手机的语言,也可以从支持的语言中选择:English、Deutsch、Español、Français、中文、한국어、हिन्दी。新语言会立即生效。

<p align="left">
<img src="../../docs/images/screen_language.jpg" alt="语言选择" height="300"/>
</p>

#### Web信令服务器

在“Web控制器”类别中点击`Web信令服务器`,输入信令服务器的WebSocket地址,例如 `ws://<服务器IP>:8080/ws`。当控制模式设置为Web服务器时会用到它,手机和服务器需要连接到同一个Wi-Fi网络。设置方法请参见[Web服务器](../../controller/web-server/README.md)。

<p align="left">
<img src="../../docs/images/dialog_web_signaling_server.jpg" alt="Web 信令服务器" height="300"/>
</p>

#### USB连接

点击USB图标打开USB选项。下拉菜单用于设置波特率。默认值为115200,除非您更改了Arduino固件,否则无需更改。应用程序会尝试自动连接,但如果遇到问题,可以使用此开关断开/连接。
Expand Down
Binary file modified docs/images/dialog_connectivity_mode.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/dialog_stream_mode.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/dialog_web_signaling_server.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ios_bluetooth_screen.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ios_language_screen.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ios_main_screen.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ios_settings_screen.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ios_web_signaling_screen.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/screen_language.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/screen_main.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/screen_settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 20 additions & 4 deletions ios/OpenBot/README.de-DE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,33 @@
Die App startet mit einem Menübildschirm, der alle verfügbaren Bildschirme anzeigt. Der Bluetooth-Verbindungsbildschirm kann durch Klicken auf das Bluetooth-Symbol oben rechts geöffnet werden. Der Einstellungsbildschirm kann durch Klicken auf das daneben befindliche Einstellungssymbol geöffnet werden. Durch Klicken auf die anderen Symbole kann der Benutzer auf verschiedene Bildschirme zugreifen, deren Funktionen in den folgenden Abschnitten erklärt werden.

<p align="left">
<img style="padding-right: 2%;" src="../../docs/images/ios_main_screen.jpg" alt="Hauptmenü" width="25%"/>
<img style="padding-right: 2%;" src="../../docs/images/ios_bluetooth_screen.jpg" alt="Bluetooth" width="25%"/>
<img style="padding-right: 2%;" src="../../docs/images/ios_settings_screen.jpg" alt="Einstellungen" width="25%"/>
<img src="../../docs/images/ios_main_screen.jpg" alt="Hauptmenü" height="400"/>
<img src="../../docs/images/ios_settings_screen.jpg" alt="Einstellungen" height="400"/>
<img src="../../docs/images/ios_bluetooth_screen.jpg" alt="Bluetooth" height="400"/>
</p>

#### Bluetooth-Verbindung

Im Gegensatz zur Android-App, die es ermöglicht, das Smartphone über ein USB-Kabel mit der Low-Level-Steuerplatine eines OpenBot zu verbinden, verlässt sich die iOS-App ausschließlich auf eine Bluetooth Low-Energy (BLE) Drahtlosverbindung. Beim Öffnen des Bluetooth-Verbindungsbildschirms in der iOS-Anwendung (durch Klicken auf das Bluetooth-Logo vom Hauptbildschirm oder von jedem Fragment aus) wird eine Liste aller kompatiblen Geräte angezeigt. Die Kompatibilität wird hier durch die Verwendung einer Reihe spezifischer UUIDs gewährleistet, die einem OpenBot-Fahrzeug sowohl auf der [App](https://github.com/3dwesupport/OpenBot/blob/090dcb28206195a7ee45a13b8ded968a8d365abe/ios/OpenBot/OpenBot/Utils/Constants.swift#L57)- als auch auf der [Firmware](https://github.com/3dwesupport/OpenBot/blob/090dcb28206195a7ee45a13b8ded968a8d365abe/firmware/openbot_nano/openbot_nano.ino#L115)-Ebene zugewiesen sind. Sie müssen sicherstellen, dass diese UUIDs übereinstimmen. Das Koppeln eines iOS-Geräts mit einem OpenBot-Fahrzeug erfordert dann lediglich die Auswahl dieses Fahrzeugs aus der Liste und das Drücken der "Verbinden"-Taste. Die Standard-Baudrate für die Verbindung ist auf 115200 eingestellt und kann auf App- und Firmware-Ebene geändert werden.

<p align="left">
<img src="../../docs/images/ios_ble.gif" alt="BLE-Verbindung" width="25%" />
<img src="../../docs/images/ios_ble.gif" alt="BLE-Verbindung" height="400" />
</p>

#### Mehrsprachige Unterstützung

Öffnen Sie den Einstellungsbildschirm über das Zahnrad-Symbol oben rechts und tippen Sie im Abschnitt „Allgemein“ auf `Sprache`, um die Anzeigesprache der App zu wählen. Wählen Sie `Systemstandard`, um die Sprache Ihres iPhones zu verwenden, oder eine der unterstützten Sprachen: English, Deutsch, Español, Français, 中文, 한국어 oder हिन्दी. Die App wendet die neue Sprache sofort an.

<p align="left">
<img src="../../docs/images/ios_language_screen.jpg" alt="Sprachauswahl" height="400"/>
</p>

#### Web-Signalisierungsserver

Geben Sie im Einstellungsbildschirm im Feld `Web-Signalisierungsserver` die WebSocket-Adresse des Signalisierungsservers ein, zum Beispiel `ws://<server-ip>:8080/ws`. Sie wird verwendet, wenn der Steuerungsmodus auf Webserver eingestellt ist. iPhone und Server müssen sich dafür im selben WLAN befinden. Die Einrichtung ist im [Webserver](../../controller/web-server/README.md) beschrieben.

<p align="left">
<img src="../../docs/images/ios_web_signaling_screen.jpg" alt="Web-Signalisierungsserver" height="400"/>
</p>

### Freies Fahren
Expand Down
Loading
Loading