update CarlaViz doc

This commit is contained in:
Minjun Xu 2020-09-26 22:21:45 +08:00 committed by bernat
parent dfa4bb6e15
commit ab4705c541
1 changed files with 10 additions and 5 deletions

View File

@ -17,8 +17,8 @@ The carlaviz plugin is used to visualize the simulation in a web browser. A wind
### Support
* __Linux__ — CARLA 0.9.6, 0.9.7, 0.9.8, 0.9.9.
* __Windows__ — CARLA 0.9.9.
* __Linux__ — CARLA 0.9.6, 0.9.7, 0.9.8, 0.9.9, 0.9.10.
* __Windows__ — CARLA 0.9.9, 0.9.10.
* __Build from source__ — Latest updates.
---
@ -40,13 +40,14 @@ docker pull mjxu96/carlaviz:0.9.6
docker pull mjxu96/carlaviz:0.9.7
docker pull mjxu96/carlaviz:0.9.8
docker pull mjxu96/carlaviz:0.9.9
docker pull mjxu96/carlaviz:0.9.10
# Pull this image if working on a CARLA build from source
docker pull carlasim/carlaviz:latest
docker pull mjxu96/carlaviz:latest
```
!!! Important
Currently in Windows there is only support for 0.9.9.
Currently in Windows there is only support for 0.9.9 and 0.9.10.
CARLA up to 0.9.9 (included) is set to be single-stream. For later versions, multi-streaming for sensors is implemented.
@ -68,10 +69,14 @@ __1. Run CARLA.__
__2. Run carlaviz.__ In another terminal run the following command according to the Docker image that has been downloaded.
Change `<name_of_Docker_image>` for the name of the image previously downloaded, e.g. `carlasim/carlaviz:latest` or `mjxu96/carlaviz:0.9.9`.
Change `<name_of_Docker_image>` for the name of the image previously downloaded, e.g. `mjxu96/carlaviz:latest` or `mjxu96/carlaviz:0.9.10`.
```sh
# On Linux system
docker run -it --network="host" -e CARLAVIZ_HOST_IP=localhost -e CARLA_SERVER_IP=localhost -e CARLA_SERVER_PORT=2000 <name_of_Docker_image>
# On Windows/MacOS system
docker run -it -e CARLAVIZ_HOST_IP=localhost -e CARLA_SERVER_IP=host.docker.internal -e CARLA_SERVER_PORT=2000 -p 8080-8081:8080-8081 -p 8089:8089 <name_of_Docker_image>
```
If the everything has been properly set, carlaviz will show a successful message similar to the following.