Skip to content
This repository has been archived by the owner on Jul 17, 2019. It is now read-only.

Latest commit

 

History

History
93 lines (80 loc) · 3.29 KB

README.md

File metadata and controls

93 lines (80 loc) · 3.29 KB
Raw

ROS VSCode Extension (Deprecated)

Note: A newer version of this extension has been published as ms-iot.vscode-ros. Please uninstall this extension and install the new one.

This Visual Studio Code (VSCode) extension provides support for Robot Operating System (ROS) development.

Getting Started

The extension will automatically start when you open a catkin workspace. The build system (e.g. catkin_make or catkin build) will automatically be confirmed from the hidden files associated with each system. The ROS distro will automatically be confirmed from the parent environment, or you will be prompted to select a ROS distro if this can't be done automatically.

You must build the catkin workspace at least once before the extension will recognise it.

To start ROS master, use the "ROS: Start Core" command. The "ROS master" indicator in the bottom left will show if the master is currently running, and you can click on this to view parameters etc. If you hit F5 you can create a debug configuration to run a rosrun or roslaunch command.

The first time you open the workspace the extension will automatically create build and test tasks and update the C++ and Python paths. You can re-run this process later using the appropriate commands.

Features

  • Automatic ROS environment configuration.
  • Allows starting, stopping and viewing the ROS master status.
  • Automatically discover catkin_make or catkin build build tasks.
  • Create catkin packages using catkin_create_pkg script or catkin create pkg.
  • Run rosrun or roslaunch (breakpoints currently not supported).
  • Syntax highlighting for .msg, .urdf and other ROS files.
  • Automatically add the ROS C++ include and Python import paths.
  • Format C++ using the ROS clang-format style.

Commands

Name Command Description
Create Catkin Package ros.createCatkinPackage Create a catkin package. You can right click on a folder in the explorer to create it in a specific location.
Create Terminal ros.createTerminal Create a terminal with ROS sourced.
Show Master Status ros.showMasterStatus Open a detail view showing details about the ROS master.
Start Core ros.startCore Spawn a ROS core
Stop Core ros.stopCore Kill the ROS core
Update C++ Properties ros.updateCppProperties Update the C++ include path to include ROS.
Update Python Path ros.updatePythonPath Update the Python path to include ROS.