Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/devrt/ros-devcontainer-vscode

ROS dev container for vscode
https://github.com/devrt/ros-devcontainer-vscode

cloud-ide devcontainer docker ide ros vscode

Last synced: about 2 months ago
JSON representation

ROS dev container for vscode

Awesome Lists containing this project

README 

        
ROS dev container for VSCode

----------------------------

Packed with:

- Preconfigured docker image for ROS development.

- Browser accessible X11 server to display gazebo, rviz, rqt (runs on Windows/Mac).

- Tasks definition to run catkin_make, roscore, rviz commands.

- Preconfigured code completion for C++, Python, XML (package.xml, launchfiles, URDF, SDF).

- Preconfigured simulation environments (Flatland, TurtleBot3, ARIAC, Virtual RobotX, UUV).

- Bonus: WebIDE (code-server) with preconfigured C++, Python, XML completion.



VSCode and devcontainer running on Mac:

![screenshot](https://user-images.githubusercontent.com/18067/58605055-8dc84980-82d1-11e9-8ee5-dc969fcb2ae1.png)



WebIDE opened from the local browser while devcontainer is running on the remote server:

![screenshot-theia](https://user-images.githubusercontent.com/18067/59972289-58a8d180-95c7-11e9-86fd-7d271684e8b3.PNG)



How to select simulation environment

-------------------------------------

You can run preconfigured simulation environment as a docker sidecar container.



Enter following command to select the simulator:

```shell

$ ./select-simulator.sh

```



Preconfigured simulation environment currently includes: Flatland, TurtleBot3, ARIAC, Virtual RobotX, UUV.



See the following index for list of current simulators:



https://github.com/devrt/simulator-index/blob/master/index.yaml



If you want any other simulator, let us know by submitting the issue:



https://github.com/devrt/simulator-index/issues



How to use the WebIDE (recommended)

-------------------------------------

As of writing, docker-compose support of VSCode is not so stable on all the platforms.

We recommend using code-server WebIDE since it has complete VSCode function support.



1. Clone this repository:

```shell

$ git clone https://github.com/devrt/ros-devcontainer-vscode.git

```



2. Enter the following command under the folder of the cloned project:

```shell

$ cd ros-devcontainer-vscode

$ docker-compose up

```



3. Open http://localhost:3001/ using your favorite browser.



You can also use remote server to host the devcontainer (run `docker-compose up` on the remote server and open `http://[remote-server]:3001`).



How to use this dev container with VSCode

-----------------------------------------

First, you have to install VSCode and Docker for Windows/Mac:

- https://code.visualstudio.com/

- https://docs.docker.com/docker-for-mac/

- https://docs.docker.com/docker-for-windows/



After you installed required softwares:



1. Install ["Remote Development" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) on your VSCode.

2. Clone this repository by using git command.

3. Click on the quick actions status bar item (green icon) in the lower left corner of the VSCode.

4. Select "Remote-Containers: Open Folder in Container..." from the command list that appears, and open the root folder of the project you just cloned.

5. You need to wait a while for container to come up (only required once).



For detailed instructions, see:

https://code.visualstudio.com/docs/remote/containers



If you are behind the proxy

-----------------------------



Please apply following two settings, if you are using your PC behind the proxy.



1. Proxy setting for the Docker server.



Click Docker Desktop task bar icon > Select `preference` menu item. You will see the following options:



![docker-proxy-settings](https://user-images.githubusercontent.com/18067/59744551-c4302d80-92ad-11e9-9b20-cc873a53a8bb.png)



In most cases, `System proxy` option will work. But if you have problem downloading the docker images, please try `Manual proxy configuration` option.



2. Proxy setting for the devcontainer.



This setting will enable you to use the `apt-get` or the other network commands inside the devcontainer.



First, open `.env.sample` file under the root folder of the cloned project.

Edit the settings according to your environment.

Save the file as name `.env`.



Next, open `docker-compose.yml` file under the root folder of the cloned project and uncomment the following lines:

```yaml

  workspace:

    env_file:

      - .env

```



How to reset or update the devcontainer

---------------------------------------



If you want to reset the devcontainer. Please close vscode and enter the following command under the folder of the cloned project:

```shell

$ docker-compose down

```



If you want to update the environment to the most recent version. Please enter the following commands under the folder of the cloned project:

```shell

$ git pull origin master

$ docker-compose pull

```



Please be noticed that the `docker-compose down` command will reset your environment including installed `.deb` packages. However, if you write `package.xml` files correctly, you can reinstall all the depending packages by entering the following two commands:

```shell

$ rosdep update

$ rosdep install --from-paths src --ignore-src -r -y

```



How to open X11 server screen

-----------------------------



1. Wait for the container to start.

2. Open http://localhost:3000/ using your favorite browser.



If you are using Docker Toolbox, open the following URL instead:



http://192.168.99.100:3000/



If you want browser screen to be integrated with VS Code, use [Browser Preview for VS Code extension](https://marketplace.visualstudio.com/items?itemName=auchenberg.vscode-browser-preview).



Created by

----------

Yosuke Matsusaka (MID Academic Promotions, Inc.)



License

-------

Code in this repository (Dockerfile, utility scripts, etc) is distributed under Apache 2.0 license.



Included components are distributed under each different licenses:

- Jupyter notebook: BSD