Skip to content

A lightweight package for providing and consuming ROS services, actions, and topics as RESTful web services

Notifications You must be signed in to change notification settings

yujinrobot/rostful

 
 

Repository files navigation

Build Status

Overview

ROStful - A REST API for ROS.

Rostful is intended to be the outside layer of a ros system, communicating with the outside world via HTTP, and exposing a REST API to use the robot services, or introspect robot topics. As such this should be launched either :

  • as a python code with the de facto python standard behaviors ( venv, pip requirements, etc. ),

python -m rostful flask

  • as a ros package, with the de facto ros standard behaviors.

roslaunch rostful rostful.launch

so that users from both world can use it efficiently.

What will not be in Rostful

  • Security related stuff ( Authentication/Authorization ) implementation. We will not provide here any Authentication/Authorization mechanisms without ROS providing one first. And even after that, the implications of such an implementation would probably fit better in another specific microservice, that we would rely on in rostful.

PYTHON VIRTUALENV SETUP

How to setup your python virtual environment on Ubuntu (tested on Trusty 14.04)

  • Install and Setup virtualenvwrapper if needed sudo apt-get install virtualenvwrapper && echo "source /etc/bash_completion.d/virtualenvwrapper" >> ~/.bashrc

  • Create your virtual environment for your project mkvirtualenv myproject --no-site-packages workon myproject

  • Populate it to use rostful. The catkin dependency is temporarily needed to be able to use the setup.py currently provided in rostful. pip install catkin-pkg rostful

About

A lightweight package for providing and consuming ROS services, actions, and topics as RESTful web services

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 91.5%
  • Python 6.0%
  • HTML 2.1%
  • Other 0.4%