Skip to content

Commit 4607c71

Browse files
committed
Delete the Buliding,Usage,Launch files part in all README.md and add Complete description part in some README.md.
1 parent c43414b commit 4607c71

File tree

6 files changed

+26
-150
lines changed

6 files changed

+26
-150
lines changed

rm_calibration_controllers/README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@ Or better, use `rosdep`:
3434

3535
sudo rosdep install --from-paths src
3636

37-
### Building from Source
37+
### Dependencies
3838

39-
#### Dependencies
4039
* roscpp
4140
* roslint
4241
* rm_msgs
@@ -49,17 +48,6 @@ Or better, use `rosdep`:
4948
* control_msgs
5049

5150

52-
#### Building
53-
54-
To build from source, clone the latest version from this repository into your catkin workspace and compile the package using
55-
56-
cd catkin_workspace/src
57-
git clone https://github.com/rm-controls/rm_controllers.git
58-
cd ../
59-
rosdep install --from-paths . --ignore-src
60-
catkin_make
61-
62-
6351
## ROS API
6452

6553
#### Service
@@ -80,6 +68,15 @@ To build from source, clone the latest version from this repository into your ca
8068
This is velocity `threshold`. When the real time velocity of target joint lower than threshold, and last for a while,
8169
it can switch CALIBRATED from MOVING.
8270

71+
#### Complete description
72+
73+
```yaml
74+
cover_controller:
75+
type: effort_controllers/JointPositionController
76+
joint: "cover_joint"
77+
pid: { p: 15.0, i: 0.0, d: 1.2, i_clamp_max: 0.0, i_clamp_min: 0.0, antiwindup: true, publish_state: true }
78+
```
79+
8380
8481
## Bugs & Feature Requests
8582

rm_chassis_controllers/README.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ Or better, use `rosdep`:
3131
sudo rosdep install --from-paths src
3232
```
3333

34-
### Building from Source
35-
36-
#### Dependencies
34+
### Dependencies
3735

3836
* [Robot Operating System (ROS)](http://wiki.ros.org/) (middleware for robotics),
3937
* roscpp
@@ -53,29 +51,6 @@ sudo rosdep install --from-paths src
5351
* imu_sensor_controller
5452
* robot_localization
5553

56-
#### Building
57-
58-
* Build this package with catkin build. Clone the latest version from this repository into your catkin workspace.
59-
60-
```
61-
catkin_workspace/src
62-
git clone https://github.com/rm-controls/rm_controllers.git
63-
rosdep install --from-paths . --ignore-src
64-
catkin build
65-
```
66-
67-
## Usage
68-
69-
Run the controller with mon launch:
70-
71-
```
72-
mon launch rm_chassis_controllers load_controllers.launch
73-
```
74-
75-
## Launch files
76-
77-
* **load_controllers.launch:** It loads tf, robot_localization and some controllers, robot_state_controller, joint_state_controller and chassis controller are included.
78-
7954
## ROS API
8055

8156
#### Subscribed Topics

rm_gimbal_controllers/README.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ Or better, use `rosdep`:
3333

3434
sudo rosdep install --from-paths src
3535

36-
### Building from Source
37-
#### Dependencies
36+
### Dependencies
3837
* roscpp
3938
* roslint
4039
* rm_msgs
@@ -52,27 +51,6 @@ Or better, use `rosdep`:
5251
* visualization_msgs
5352
* dynamic_reconfigure
5453

55-
#### Building
56-
57-
To build from source, clone the latest version from this repository into your catkin workspace and compile the package using
58-
59-
cd catkin_workspace/src
60-
git clone https://github.com/rm-controls/rm_controllers.git
61-
cd ../
62-
rosdep install --from-paths . --ignore-src
63-
catkin build
64-
65-
66-
## Usage
67-
68-
Run the controller with mon launch:
69-
70-
mon launch rm_gimbal_controller load_controllers.launch
71-
72-
## Launch files
73-
74-
* **load_controllers.launch**: Load the parameters in config files and load tf and robot_state_controller, joint_state_controller, gimbal_controller.
75-
7654
## ROS API
7755

7856
#### Subscribed Topics

rm_orientation_controller/README.md

Lines changed: 12 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -58,26 +58,13 @@ Or better, use `rosdep`:
5858

5959
sudo rosdep install --from-paths src
6060

61-
### Building from Source
62-
63-
#### Dependencies
61+
### Dependencies
6462

6563
- [Robot Operating System (ROS)](http://wiki.ros.org) (middleware for robotics),
6664
- [Eigen] (linear algebra library)
6765

6866
sudo rosdep install --from-paths src
6967

70-
#### Building
71-
72-
To build from source, clone the latest version from this repository into your catkin workspace and compile the package
73-
using
74-
75-
cd catkin_workspace/src
76-
git clone https://github.com/ethz-asl/ros_best_practices.git
77-
cd ../
78-
rosdep install --from-paths . --ignore-src
79-
catkin_make
80-
8168
### Running in Docker
8269

8370
Docker is a great way to run an application with all dependencies and libraries bundles together. Make sure
@@ -113,14 +100,6 @@ Run the static code analysis with
113100

114101
catkin_make roslint_ros_package_template
115102

116-
## Usage
117-
118-
Describe the quickest way to run this software, for example:
119-
120-
Run the main node with
121-
122-
roslaunch ros_package_template ros_package_template.launch
123-
124103
## Config files
125104

126105
Config file folder/set 1
@@ -131,20 +110,6 @@ Config file folder/set 2
131110

132111
* **...**
133112

134-
## Launch files
135-
136-
* **launch_file_1.launch:** shortly explain what is launched (e.g standard simulation, simulation with gdb,...)
137-
138-
Argument set 1
139-
140-
- **`argument_1`** Short description (e.g. as commented in launch file). Default: `default_value`.
141-
142-
Argument set 2
143-
144-
- **`...`**
145-
146-
* **...**
147-
148113
## Nodes
149114

150115
### ros_package_template
@@ -183,6 +148,17 @@ Reads temperature measurements and computed the average.
183148

184149
...
185150

151+
#### Complete description
152+
153+
```yaml
154+
orientation_controller:
155+
type: rm_orientation_controller/Controller
156+
publish_rate: 100
157+
name: "gimbal_imu"
158+
frame_source: "odom"
159+
frame_target: "base_link"
160+
```
161+
186162
## Bugs & Feature Requests
187163
188164
Please report bugs and request features using the [Issue Tracker](https://github.com/gdut-dynamic-x/rm_template/issues)

rm_shooter_controllers/README.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@ or better use `rosdep`:
3737
sudo rosdep install --from-paths src
3838
```
3939

40-
### Building from Source
41-
42-
#### Dependencies
40+
### Dependencies
4341

4442
- rm_description
4543
- roscpp
@@ -55,33 +53,10 @@ sudo rosdep install --from-paths src
5553
- effort_controllers
5654
- dynamic_reconfigure
5755

58-
#### Building
59-
60-
To build this package with catkin build. Clone the latest version from this repository into your catkin workspace.
61-
62-
```
63-
catkin_workspace/src
64-
git clone https://github.com/rm-controls/rm_controllers.git
65-
rosdep install --from-paths . --ignore-src
66-
catkin build
67-
```
68-
69-
## Usage
70-
71-
Run the controller with mon launch:
72-
73-
```
74-
mon launch rm_shooter_controllers load_controllers.launch
75-
```
76-
7756
## Cfg
7857

7958
+ **shooter.cfg:** Add parameters related to friction wheel's angular velocity corresponding to each bullet speed and trigger block detection parameters.
8059

81-
## Launch files
82-
83-
- **load_controller.launch:** Load the parameters in config files and load the shooter controller.
84-
8560
## ROS API
8661

8762
#### Subscribed Topics

robot_state_controller/README.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@ or better use `rosdep`:
3737
sudo rosdep install --from-paths src
3838
```
3939

40-
### Building from Source
41-
42-
#### Dependencies
40+
### Dependencies
4341

4442
* roscpp
4543
* roslint
@@ -53,29 +51,6 @@ sudo rosdep install --from-paths src
5351
* realtime_tools
5452
* pluginlib
5553

56-
#### Building
57-
58-
To build this package with catkin build. Clone the latest version from this repository into your catkin workspace.
59-
60-
```bash
61-
catkin_workspace/src
62-
git clone https://github.com/rm-controls/rm_controllers.git
63-
rosdep install --from-paths . --ignore-src
64-
catkin build
65-
```
66-
67-
## Usage
68-
69-
Run the controller with mon launch:
70-
71-
```shell
72-
mon launch robot_state_controller load_controllers.launch
73-
```
74-
75-
## Launch files
76-
77-
- **load_controller.launch:** Load the parameters in config files and load the robot_state_controller.
78-
7954
## ROS API
8055

8156
#### Subscribed Topics

0 commit comments

Comments
 (0)