Skip to content

Commit

Permalink
Merge pull request #19 from CMU-cabot/daisukes-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
kimushun1101 authored Apr 3, 2024
2 parents b339ab8 + f4e5d62 commit bfd44de
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,30 +41,38 @@

```
./build-docker.sh -p -i -w # run prebuild, image build, and workspace build
./build-docker.sh -p -i -w -d # run prebuild, image build, and workspace debug build (symlink-install)
```

### Run test cases
### Run simulator and run test cases

- set .env file
- set .env file (example)

```
CABOT_MODEL=cabot2-gt1
CABOT_SITE=cabot_site_cmu_3d
RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
```

- run the test
- run simulator

```
./launch.sh -s -y # simulation, yes to launch a map server
./launch.sh -s -y -t # simulation, yes to launch a map server, run test
./launch.sh -s # simulation, yes to launch a map server
```

- run test cases

```
./launch.sh -s -t # simulation, yes to launch a map server, run test
./launch.sh -s -t -H # simulation, yes to launch a map server, run test, headless
```

### .env file

- **Required settings**
```
CABOT_MODEL # robot model (default=) to determine which launch/urdf to use
CABOT_SITE # package name for cabot site (default=)
CABOT_TOUCH_PARAMS # touch sensor parameter for cabot-arduino handle (default=[128,48,24])
RMW_IMPLEMENTATION=rmw_cyclonedds_cpp # need to use cyclone dds due to performance issue
```
- Optional settings
Expand Down

0 comments on commit bfd44de

Please sign in to comment.