# ROS_Flutter_Gui_App

**Repository Path**: l6yang/ROS_Flutter_Gui_App

## Basic Information

- **Project Name**: ROS_Flutter_Gui_App
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-04-16
- **Last Updated**: 2025-12-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

# ROS Flutter GUI App

[中文](README.md) | [English](#english)

<p align="center">
<img src="https://img.shields.io/github/last-commit/chengyangkj/ROS_Flutter_Gui_App?style=flat-square" alt="GitHub last commit"/>
<img src="https://img.shields.io/github/stars/chengyangkj/ROS_Flutter_Gui_App?style=flat-square" alt="GitHub stars"/>
<img src="https://img.shields.io/github/forks/chengyangkj/ROS_Flutter_Gui_App?style=flat-square" alt="GitHub forks"/>
<img src="https://img.shields.io/github/issues/chengyangkj/ROS_Flutter_Gui_App?style=flat-square" alt="GitHub issues"/>
<a href="http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=mvzoO6tJQtu0ZQYa_itHW7JrT0i4OCdK&authKey=exOT53pUpRG85mwuSMstWKbLlnrme%2FEuJE0Rt%2Fw6ONNvfHqftoWMay03mk1Qi7yv&noverify=0&group_code=797497206"><img alt="QQ Group" src="https://img.shields.io/badge/QQ%e7%be%a4-797497206-purple"/></a>
</p>

<p align="center">
<img src="https://github.com/chengyangkj/ROS_Flutter_Gui_App/actions/workflows/web_build.yaml/badge.svg" alt="web"/>
<img src="https://github.com/chengyangkj/ROS_Flutter_Gui_App/actions/workflows/android_build.yaml/badge.svg" alt="android"/>
<img src="https://github.com/chengyangkj/ROS_Flutter_Gui_App/actions/workflows/linux_build.yaml/badge.svg" alt="linux"/>
<img src="https://github.com/chengyangkj/ROS_Flutter_Gui_App/actions/workflows/windows_build.yaml/badge.svg" alt="windows"/>
</p>

</div>

## Introduction

ROS Flutter GUI App is a cross-platform ROS robot human-machine interface developed with Flutter, supporting both ROS1/ROS2. It can run on Android, iOS, Web, Linux, Windows and other platforms. Communication with ROS systems is implemented through rosbridge websocket.

### Key Features

- 🌟 Cross-platform support - Android, iOS, Web, Linux, Windows
- 🤖 Support for ROS1/ROS2
- 🗺️ Map display and navigation
- 📹 Camera image display
- 🎮 Robot remote control
- 🔋 Battery status monitoring
- 📍 Multi-point navigation
- 🛠️ Highly configurable

### Demo

![main interface](./doc/image/main.gif)
![mapping](./doc/image/mapping.gif)

## Feature List

| Feature                       | Status | Note                      |
| ----------------------------- | ------ | ------------------------- |
| ROS1/ROS2 Communication       | ✅      |                           |
| Map Display                   | ✅      |                           |
| Robot Position Display        | ✅      |                           |
| Speed Control                 | ✅      |                           |
| Relocation                    | ✅      |                           |
| Single/Multi-point Navigation | ✅      |                           |
| Path Planning Display         | ✅      |                           |
| Battery Monitoring            | ✅      |                           |
| Camera Display                | ✅      | Requires web_video_server |
| Map Editing                   | ❌      | In development            |
| Topological Map               | ❌      | Planned                   |

## Quick Start

### Installation

1. Download the installation package for your platform from [Release](https://github.com/chengyangkj/ROS_Flutter_Gui_App/releases)

2. Install ROS dependencies:

```bash
# ROS1
sudo apt install ros-${ROS_DISTRO}-rosbridge-suite

# ROS2
sudo apt install ros-${ROS_DISTRO}-rosbridge-suite
```

### Configuration

1. Launch rosbridge:

```bash
# ROS1
roslaunch rosbridge_server rosbridge_websocket.launch

# ROS2
ros2 launch rosbridge_server rosbridge_websocket_launch.xml
```

2. Run the application and configure connection parameters

## Detailed Documentation

- [Installation Guide](docs/installation_EN.md) - Installation steps and environment configuration for each platform
- [Configuration Guide](docs/configuration_EN.md) - Detailed parameter configuration and default values
- [User Guide](docs/usage_EN.md) - Software functionality instructions and best practices

## Star History

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=chengyangkj/Ros_Flutter_Gui_App&type=Timeline&theme=dark" />
  <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=chengyangkj/Ros_Flutter_Gui_App&type=Timeline" />
  <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=chengyangkj/Ros_Flutter_Gui_App&type=Timeline" width="75%" />
</picture>

## Contributing

Issues and Pull Requests are welcome. See [Contributing Guide](CONTRIBUTING.md) for details.

## Acknowledgments

- [ros_navigation_command_app](https://github.com/Rongix/ros_navigation_command_app)
- [roslibdart](https://pub.dev/packages/roslibdart)
- [matrix_gesture_detector](https://pub.dev/packages/matrix_gesture_detector)

## License

This project is licensed under [CC BY-NC-SA 4.0](LICENSE).