Giter Club home page Giter Club logo

mas_domestic_robotics's Introduction

Build Status

mas_domestic_robotics

Table of contents

  1. Summary
  2. Dependencies
  3. Packages
    1. Planning
    2. Naming conventions
  4. Getting started
  5. Docker images
    1. Building the bitbots-domestic image
    2. Travis
  6. License
  7. Acknowledgments

Summary

This repository contains various core domestic robotics functionalities developed by the Autonomous Systems group at Hochschule Bonn-Rhein-Sieg.

The code in this repository is mostly ROS-based and is developed in a robot-independent manner. Robot-dependent code and/or configuration files are hosted in robot-specific repositories, e.g. mas_cob for our Care-O-bot.

Dependencies

mas_domestic_robotics is not a standalone repository and depends on many other components. A diagram of the major dependencies is shown below:

mas_domestic_robotics repository dependency diagram

Most of the major dependencies are also developed in-house and, in the interest of modularity, are hosted in separate repositories.

A more complete set of dependencies can be found in the mas-domestic.rosinstall file.

Packages

The functionalities in this repository are organised based on the main capabilities a domestic robot needs to possess. Each of these has its own ROS metapackage, which further includes a set of packages related to that particular functionality. A rough summary of the contents of these packages contents can be found below:

  • mdr_navigation - Mapping and autonomous navigation
  • mdr_manipulation - Grasp planner
  • mdr_hri - Visualization, sound vocalization, graphical user interfaces
  • mdr_msgs - ROS messages for all the mas_domestic_robotics packages
  • mdr_speech - Speech recognition and NLP
  • mdr_perception - Object recognition, people detection and recognition.

Planning

The planning metapackage is where most of the high-level functionalites of our robots are implemented. We are developing our robots as skill-based agents; the planning metapackage includes action and scenario metapackages because of that. The action metapackage is further divided into metapackages for actions related to particular capabilities, while the scenario metapackage includes domain files and/or state machines for various scenarios (e.g. RoboCup@Home tasks, lab demos, and so forth). In principle, scenarios are built by integrating actions together, which is the main benefit of the skill-based agent framework.

Naming conventions

All packages in our domestic code base start with the mdr_ suffix; this stands for mas_domestic_robotics, which is the name of the top-level directory/ROS metapackage.

Getting started

b-it-bots members can use these instructions to setup a complete development environment for all our robots.

For external users, the following instructions should get you a working system:

  1. Set up a catkin workspace
mkdir -p ~/catkin_ws/src && cd ~/catkin_ws
wstool init src
wstool merge -t src https://raw.githubusercontent.com/b-it-bots/mas_domestic_robotics/devel/mas-domestic.rosinstall
  1. Get the code and dependencies
  wstool update -t src
  rosdep install --from-paths src --ignore-src --rosdistro=kinetic -y
  1. Build the code
catkin build

If you encounter any problems, please check the list of issues and open a new one if you don't see a discussion of the problem there.

Docker images

If you want to test locally without installing our software and its dependencies, you need to install docker and docker-compose.

You can pull the image for this repository:

docker pull bitbots/bitbots-domestic:kinetic

Building the bitbots-domestic image

To manually build this image, first cd into this repository, then execute

docker build -t bitbots/bitbots-domestic:kinetic .

Travis

We use continuous integration to ensure the quality of our software. To check locally if your changes will pass the tests, execute

docker-compose build
docker-compose run travis

License

This project is licensed under the GPLv3 License - see the LICENSE.md file for details.

Acknowledgments

This software would be impossible without

  • the many generations of b-it-bots@Home members. A list of contributors can be found here
  • the MAS staff and professors who have provided their advice and support

mas_domestic_robotics's People

Contributors

agrija9 avatar alex-mitrevski avatar argenos avatar brsu-student avatar danningwang avatar divindevaiah avatar erickkramer avatar frederikhegger avatar garinkid avatar gecortesh avatar henrikschnor avatar ishanchaks91 avatar jcmayoral avatar jsanch2s avatar mas-hsr avatar minhnh avatar moriarty avatar oscar-lima avatar patrickna avatar rkutty1 avatar robertocaiwu avatar shehzi001 avatar sthoduka avatar svenschneider avatar vanargh avatar zuhakarim avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.