Skip to content
Visual Studio Code extension for Robot Operating System (ROS) development
Branch: master
Clone or download
Pull request Compare This branch is 46 commits ahead, 4 commits behind ajshort:master.
seanyen and kejxu update cpp property per platform (#73)
* Create cpp property per platform.
* update cpp properties change (#1)
* update cpp properties change
* parse CMAKE_PREFIX_PATH to get includeDirs
* update version number in package-lock.json (npm install)
* clean up changes
Latest commit 30cc2de Jul 16, 2019

README.md

Visual Studio Code Extension for ROS

Build Status

The Visual Studio Code Extension for ROS provides support for Robot Operating System (ROS) development. Providing an easier and more stream-lined developer experience.

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 core, use the "ROS: Start Core" command. The "ROS Core" indicator in the bottom left will show if the core 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 (not yet supported on Windows).

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 core 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 Core Status ros.showCoreStatus Open a detail view showing ROS core runtime status.
Start Core ros.startCore Spawn a ROS core
Stop Core ros.stopCore Terminate 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.

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.

Further information, including the MSRC PGP key, can be found in the Security TechCenter.

Data and Telemetry

This extension collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more.

This extension respects the telemetry.enableTelemetry setting, learn more about this option.

Contributors

A big Thank you! to everyone that have helped make this extension better!

You can’t perform that action at this time.