PAI's project

Code and documentation for a UGV that can work and be teleoperated in a cultivate.

Demo

demo.mp4

Explore the docs »

View Demo · Report Bug · Request Feature

📝Table of contents

• 📌About The Project
  • Built With
• 🏁Getting Started
  • Prerequisites
  • Installation
• 🎈Usage
• 🎢Roadmap
• 👥Contributing
• 🔑License
• ✏️Authors
• 🎉Acknowledgments

📌About The Project

Welcome to the <package_name> ROS 1 package repository! This package contains source code and documentation for a UGV that can work in a field. This project is part of the PAI subject at the Universidad Nacional de Colombia.

Note: This package is being developed using ROS noetic

Built With

• 

🏁Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

In order to avoid installing ROS on your local machine, we will be using a docker image to run ROS. So, you will just need to install Docker in your local machine.

Installation

1. Clone the repo

   git clone --recurse-submodules https://github.com/cychitivav/pai.git

2. Build the docker image

   docker build -t pai:latest .

3. Run the docker image

   docker run -it \
    		   --rm \
   		   -v /tmp/.X11-unix:/tmp/.X11-unix:rw \
              -v $PWD:/root/catkin_ws/src/pai \
   		   --name pai \
   		   pai:latest

   Note: If you have troubles with the display, try to run the following command before running the docker image:

   xhost +local:root

🎈Usage

In order to run the package, you will need to follow the next steps from the workspace directory (catkin_ws):

1. Compile packages

catkin build

1. Source the workspace

source devel/setup.bash

1. Launch the package

roslaunch pai view_robot.launch

🎢Roadmap

• Feature 1
• Feature 2
  • Nested Feature

Note: See the open issues for a full list of proposed features (and known issues).

👥Contributing

If you have a suggestion that would make this better, please create a pull request.

1. Create your Branch (git checkout -b <type>/<name>)
2. Commit your Changes (git commit -m 'Add some AmazingFeature')
3. Push to the Branch (git push origin <type>/<name>)
4. Open a Pull Request (in the git push response, it appears a link to open a PR)

The available contribution types are:

• docs
• feat
• dev
• fix

Don't forget to give the project a star! Thanks again!

🔑License

Distributed under the MIT License. See LICENSE for more information.

✏️Authors

• @cychitivav
• @jsduenass
• @juvallejom

🎉Acknowledgments

⏫back to top