roslib_dart/README.md

83 lines
2.2 KiB
Markdown
Raw Normal View History

2022-02-21 14:22:44 +08:00
# roslibdart
2022-02-21 17:58:22 +08:00
The is a fork of the original roslib by Eternali Conrad Heidebrecht (@Eternali), Artur Rymarz (@artrmz), TimWhiting Tim Whiting (@TimWhiting). roslibdart is a library for communicating to a ROS node over websockets with rosbridge. It is heavily influenced by roslibjs and follows the same structure. This fork is an effort to update the library and make it compatible to null safety, dart2 and ros2.
2022-02-21 14:22:44 +08:00
## List of feature implementation statuses (essentially a list of features required to reach roslibjs's level)
- [X] Core:
- [x] ROS connection object
- [x] Topic object (subscribe, unsubscribe, publish, advertise, unadvertise)
- [x] Service object (call, advertise, unadvertise)
- [x] Request object (provides typing and naming to any potential ROS request)
- [x] Param object (get, set, delete)
2022-02-21 17:58:22 +08:00
2022-02-21 14:22:44 +08:00
## Usage
### Install rosbridge
You can either
```
# install using apt-get
sudo apt-get install ros-foxy-rosbridge-server
# or you can clone from github
cd ros_ws/src
git clone https://github.com/RobotWebTools/rosbridge_suite
cd ..
colcon build
```
### Run ros bridge
```
2022-02-21 17:58:22 +08:00
cd ros_ws
2022-02-21 14:22:44 +08:00
source install/local_setup.bash
ros2 launch rosbridge_server rosbridge_websocket_launch.xml
```
2022-02-22 20:23:58 +08:00
## Testing publisher
2022-02-21 14:22:44 +08:00
### Run topic publisher
```
# Assume ros_ws is your workspace
cp -r rospackage/* ~/ros_ws/src/
cd ~/ros_ws
colcon build
source install/local_setup.bash
ros2 run tutorial publisher
```
### Fire up flutter subscriber
```
cd example/subscriber
flutter run -d linux
```
2022-02-22 20:23:58 +08:00
## Testing subscriber
### Run topic subscriber
```
ros2 run tutorial subscriber
```
### Fire up flutter publisher
```
cd example/publisher
flutter run -d linux
2022-02-21 14:22:44 +08:00
2022-02-22 20:23:58 +08:00
```
## Testing call
### Run tutorial addtwoint service
```
ros2 run tutorial service
```
```
cd example/client
flutter run -d linux
```
## Testing providing service
### Fire up flutter service
2022-02-21 14:22:44 +08:00
2022-02-22 20:23:58 +08:00
### Run the client from shell
```
ros2 run tutorial client 2 3
```
2022-02-21 17:58:22 +08:00
## Links
- [ROSBridge Protocol v2.0](https://github.com/biobotus/rosbridge_suite/blob/master/ROSBRIDGE_PROTOCOL.md).
- [Original roslib library from Conrad Heidebrecht](https://github.com/Eternali/roslib)
2022-02-22 20:23:58 +08:00
- [RosBridge server implementation](https://github.com/RobotWebTools/rosbridge_suite)