updated readme

This commit is contained in:
Ruixiang Du
2021-04-08 11:12:52 +08:00
parent 2492676903
commit 70c6981bd9

View File

@@ -3,18 +3,19 @@
![GitHub Workflow Status](https://github.com/westonrobot/wrp_sdk/workflows/Cpp/badge.svg)
![GitHub Workflow Status](https://github.com/westonrobot/wrp_sdk/workflows/ROS/badge.svg)
This repository is a joint effort by the development teams at [Weston Robot](https://www.westonrobot.com/) (Singapore) and [AgileX Robotics](http://www.agilex.ai) (China).
## Introduction
| Package Name | Description | Developed By |
| :----------: | :------------------------------------------------: | :------------------------------: |
| ugv_sdk | encoding/decoding of robot communication protocols | Weston Robot and AgileX Robotics |
| wrp_io | generic asynchronous communication handling | Weston Robot |
This software package provides a C++ interface to communicate with the mobile platforms from Weston Robot and AgileX Robotics, for sending commands to the robot and receiving the latest robot state. The repository is a joint effort by the development teams at Weston Robot (Singapore) and AgileX Robotics (China).
- Copyright (c) 2020 [Weston Robot](https://www.westonrobot.com/)
- Copyright (c) 2020 [AgileX Robotics](http://www.agilex.ai/?lang=zh-cn)
Please create an issue on Github at https://github.com/westonrobot/ugv_sdk/issues if you encounter any problems in using the packages.
## Introduction
**Important Note:** Currently we're transitioning the communication protocol from version 1 to version 2. Please check with Weston Robot or AgileX Robotics to confirm which version your robot is using.
This software package provides a C++ interface to communicate with the mobile platforms from Weston Robot and AgileX Robotics, for sending commands to the robot and receiving the latest robot state.
* V1 Protocol: master branch of scout_ros and ugv_sdk
* V2 Protocol: v2.x branch of scout_ros and ugv_sdk
Supported robot platforms