Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App ReadMe: add animations and refine text #321

Merged
merged 1 commit into from
Dec 21, 2022
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
20 changes: 14 additions & 6 deletions android/app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ care is neccessary when using automated control (e.g. person following or drivin
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 style="padding-right: 2%;" src="../../docs/images/screen_main.jpg" alt="Main Menu" width="25%"/>
<img style="padding-right: 2%;" src="../../docs/images/screen_main.gif" alt="Main Menu" width="25%"/>
<img src="../../docs/images/screen_settings.jpg" alt="Settings Menu" width="25%"/>
</p>

Expand Down Expand Up @@ -95,7 +95,7 @@ If a model is active, the inference speed in [ms] will be displayed next to the
Free Roam offers simple robot control with real time updates and information about battery, speed and distance from surfaces.

<p align="left">
<img src="../../docs/images/screen_free_roam.jpg" alt="Alt text" width="50%" />
<img src="../../docs/images/screen_free_roam.jpg" alt="Free Roam" width="50%" />
</p>

- **Battery**: The battery icon shows realtime battery levels of the connected robot.
Expand All @@ -119,7 +119,7 @@ Free Roam offers simple robot control with real time updates and information abo
Simple UI for collection of data sets.

<p align="left">
<img src="../../docs/images/screen_data_collection.jpg" alt="Alt text" width="50%" />
<img src="../../docs/images/screen_data_collection.jpg" alt="Data Collection" width="50%" />
</p>

- **Preview Resolution**: Used to switch between resolutions of camera preview. There are 3 settings:
Expand All @@ -140,15 +140,23 @@ Simple UI for collection of data sets.
Simple UI to check the button and joystick mapping of a connected BT controller.

<p align="left">
<img src="../../docs/images/screen_controller_mapping.jpg" alt="Alt text" width="50%" />
<img src="../../docs/images/screen_controller_mapping.jpg" alt="Controller Mapping" width="50%" />
</p>

### Robot Info

Simple UI to get robot info and test basic functionality. The **Robot Type** as configured in the firmware is displayed as text and animation. The checkmarks in the sections **Sensors**, **Wheel Odometry** and **LEDs** show which features are supported by the connected robot. The section **Readings** provides the most important sensor measurements. In the section **Send Commands**, users can send basic motor commands by pressing the corresponding buttons and control the front and rear LEDs with a slider.

<p align="left">
<img src="../../docs/images/screen_robot_info.gif" alt="Robot Info" width="50%" />
</p>

### Autopilot

Simple UI for running autopilot models.

<p align="left">
<img src="../../docs/images/screen_autopilot.jpg" alt="Alt text" width="50%" />
<img src="../../docs/images/screen_autopilot.jpg" alt="Autopilot" width="50%" />
</p>

### Object Tracking
Expand All @@ -173,7 +181,7 @@ Note that this fragment requires ARCore and camera permission. If your device do
All models are quantized for better performance on embedded devices. Please refer to section below for a short description of the available models and benchmarking results. The [mean Average Precision (mAP)](https://kharshit.github.io/blog/2019/09/20/evaluation-metrics-for-object-detection-and-segmentation) is computed on the validation set of the [COCO Detection 2017](https://cocodataset.org/#detection-2017) dataset. Each model is run for about 1 minute; the inference time is averaged across the last 100 frames and reported in frames per second (fps). Note that models with larger input resolution might be better for smaller objects despite lower mAP.

<p align="left">
<img src="../../docs/images/screen_model_management.jpg" alt="Alt text" width="25%" />
<img src="../../docs/images/screen_model_management.gif" alt="Model Management" width="25%" />
</p>

### Benchmark
Expand Down
Binary file added docs/images/screen_main.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/screen_main.jpg
Binary file not shown.
Binary file added docs/images/screen_model_management.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/screen_model_management.jpg
Binary file not shown.
Binary file added docs/images/screen_robot_info.gif
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.