Skip to content

Commit

Permalink
add chinese readme files in subfolders (#426)
Browse files Browse the repository at this point in the history
* add chinese README files
  • Loading branch information
thias15 authored Jun 2, 2024
1 parent 41c8e9b commit abfae52
Show file tree
Hide file tree
Showing 42 changed files with 3,308 additions and 557 deletions.
2 changes: 1 addition & 1 deletion android/README.de-DE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">
<a href="README.md">English</a> |
<a href="README_CN.md">简体中文</a> |
<a href="README.zh-CN.md">简体中文</a> |
<span>Deutsch</span>
</p>

Expand Down
2 changes: 1 addition & 1 deletion android/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">
<span>English</span> |
<a href="README_CN.md">简体中文</a> |
<a href="README.zh-CN.md">简体中文</a> |
<a href="README.de-DE.md">Deutsch</a>
</p>

Expand Down
66 changes: 66 additions & 0 deletions android/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Android Apps

<p align="center">
<a href="README.md">English</a> |
<span>简体中文</span> |
<a href="README.de-DE.md">Deutsch</a>
</p>

## 功能

点击下面的链接阅读应用程序的功能。

- [机器人应用](robot/README.md)
- [控制器应用](controller/README.md)

## 安装应用程序

获取应用程序的最简单方法是使用相应的二维码直接下载到手机上。如果你在手机浏览器上,也可以直接点击二维码。然后你可以在手机上打开apk并[安装](https://www.lifewire.com/install-apk-on-android-4177185)它。请注意,apk仅使用调试密钥签名。

<table style="width:100%;border:none;text-align:center">
<tr>
<td> <a href="https://app.openbot.org/robot" target="_blank">
<img alt="🤖 App" width="50%" src="../docs/images/robot_app_qr_code.png" />
</a>
</td>
<td>
<a href="https://app.openbot.org/controller" target="_blank">
<img alt="🎮 App" width="50%" src="../docs/images/controller_app_qr_code.png" />
</a>
</td>
</tr>
<tr>
<td>🤖 App</td>
<td>🎮 App</td>
</tr>
</table>

或者,你可以从任何[发布](https://github.com/intel-isl/OpenBot/releases)的资产中下载apk。如果你想要来自主分支的最新应用程序,你也可以从构建工件[这里](https://github.com/intel-isl/OpenBot/actions?query=workflow%3A%22Java+CI+with+Gradle%22)下载。请注意,它可能不稳定。如果你以后想对应用程序进行更改,请按照以下步骤编译应用程序并将其部署到手机上。

## 构建应用程序

### 先决条件

- [Android Studio Electric Eel | 2022.1.1或更高版本](https://developer.android.com/studio/index.html)用于构建和安装apk。
- Android设备和最低API 21的Android开发环境。
- 目前,我们使用API 33作为编译SDK和API 32作为目标SDK。它应该会自动安装,但如果没有,你可以手动安装SDK。进入Android Studio -> Preferences -> Appearance & Behaviour -> System Settings -> Android SDK。确保API 33已选中并点击应用。

![Android SDK](../docs/images/android_studio_sdk.jpg)

### 构建过程

1. 打开Android Studio并选择*打开现有的Android Studio项目*
2. 选择OpenBot/android目录并点击确定。
3. 如果你想安装[OpenBot应用](app/README.md),请确保选择*app*配置。如果你想安装[控制器应用](controller/README.md),请选择*controller*配置。如有必要,确认Gradle同步。要手动执行Gradle同步,请点击gradle图标。
![Gradle Sync](../docs/images/android_studio_bar_gradle.jpg)
4. 连接你的Android设备,并确保在[开发者选项](https://developer.android.com/studio/debug/dev-options)中启用USB调试。根据你的开发环境,可能需要[进一步的步骤](https://developer.android.com/studio/run/device)。现在你应该可以在顶部的导航栏中看到你的设备。
![Phone](../docs/images/android_studio_bar_phone.jpg)
5. 点击运行按钮(绿色箭头)或从顶部菜单中选择运行 > 运行'android'。你可能需要使用构建 > 重建项目来重新构建项目。
![Run](../docs/images/android_studio_bar_run.jpg)
6. 如果它要求你使用即时运行,请点击*继续不使用即时运行*

### 故障排除

#### 版本

如果你收到类似`项目正在使用不兼容版本(AGP 7.4.0)的Android Gradle插件。最新支持的版本是AGP 7.3.0`的消息,你需要升级Android Studio或降级你的gradle插件。你可以在[这里](https://developer.android.com/studio/releases/gradle-plugin#android_gradle_plugin_and_android_studio_compatibility)阅读更多关于Android Studio和gradle插件之间版本兼容性的信息。
95 changes: 0 additions & 95 deletions android/README_CN.md

This file was deleted.

80 changes: 80 additions & 0 deletions android/controller/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# 控制器应用

<p align="center">
<a href="README.md">English</a> |
<span>简体中文</span> |
<a href="README.de-DE.md">Deutsch</a>
</p>

这款安卓应用程序作为 [OpenBot](https://www.openbot.org) 车辆的 `远程控制器`。基本上,它的功能类似于PS3/4或Xbox的遥控器,但运行在另一台安卓设备上。

## 连接

当控制器应用启动时,它会立即尝试连接到机器人。我们会看到以下屏幕:

<p float="left">
<img src="../../docs/images/controller_pre_connect.png" width="50%" />
</p>

要将控制器连接到机器人,请将机器人的应用控制设置置于 **Phone** 模式。

<p float="left">
<img src="../../docs/images/app_controller_settings_1.png" width="25%" />
<img src="../../docs/images/app_controller_settings_2.png" width="25%" />
</p>

你也可以通过在 `FreeRoamFragment` 中选择手机作为控制器来连接控制器:

<p float="left">
<img src="../../docs/images/free-roam-fragment-selection.png" width="50%" />
</p>

几秒钟后,你会听到一声哔声,控制器的屏幕会变成:

<p float="left">
<img src="../../docs/images/controller_command_buttons.png" width="50%" />
</p>

在这里,你可以选择通过倾斜手机或使用屏幕上的控制来驾驶机器人。

***注意:*** 这应该足以连接,但如果在30秒后仍无法建立连接,请将机器人应用的 `Control` 设置切换到 `Gamepad`,然后再切换回 `Phone` 以重新启动连接。如果仍然失败,请退出控制器应用并重新启动。再次切换机器人应用上的控制模式。

## 操作

### 屏幕控制
这种模式允许用户通过 `双驱动` 模式下的两个滑块来控制机器人车。你可以通过在每一侧上下移动滑块的滑块拇指来左转/右转。当滑块拇指移动到滑块中心的上方/下方时,每一侧的轮子会向前/向后转动。

<p float="left">
<img src="../../docs/images/controller_main_screen.png" width="50%" />
</p>

你还可以通过点击屏幕左上角的箭头来设置左/右转向指示灯
<img src="../../docs/images/keyboard_arrow_left-24px.svg" height="24"/>
<img src="../../docs/images/keyboard_arrow_right-24px.svg" height="24"/>
以及中间的红色按钮来取消。

### 倾斜驾驶
控制器还可以使用其加速度计运动传感器来驾驶机器人。如果你选择此选项,控制器将进入全屏(Zen)模式,只有视频显示和 `刹车``加速` 踏板。要退出此模式,请双击屏幕。

这是 `倾斜模式` 屏幕的图片:

<p float="left">
<img src="../../docs/images/tilt-mode-controller.jpg" width="50%" />
</p>

使用 `加速``刹车` 按钮来前进/后退。

- 按下 `加速` 按钮,机器人将在2秒内加速到全速。当你松开按钮时,机器人会减速至停止(停止速度设置为最大速度的0%,可以调整)。
- 按下 `刹车` 按钮,机器人会立即停止。如果我们再按住刹车一秒钟,机器人会开始倒退,直到在一秒钟内达到最大倒车速度。当我们松开刹车时,机器人会停止。
- 我们通过左右倾斜控制器来转向机器人。

## 未来发展

我们计划添加的一些功能包括:

- 在控制器上添加更多机器人传感器的信息,如电池电量和速度。
- 从机器人的摄像头向控制器传输视频流
- 使用控制器的陀螺仪传感器来控制机器人
- 从机器人向控制器发送碰撞和撞击事件,以获得更真实的体验

这里有一个控制器应用的 [技术概述](../../docs/technical/OpenBotController.pdf)
Loading

0 comments on commit abfae52

Please sign in to comment.