/krembot_sim_fork

fork of Kermbot Sim buy Gal Kaminka

Primary LanguageC++MIT LicenseMIT

Krembot Simulator

A physics-based 3D simulator for Robotican's Krembot robot. Original code by Elhay Rauper for Bar Ilan University and the ISF Smart Swarms center. Uses and modifies (and adds to) the Argos multi-robot simulator.

Notes:

  • This simulation was tested and intended to work under Linux Ubuntu 16.04.6 LTS/Mint 18.4

  • Whenever krembot_sim directory mentioned in this README file, it referes to the root directory of this package.

Directories Tree

There are 3 main directories in the package:

  1. argos3 - contain argos simulation files
  2. krembot - contain krembot library simulation files
  3. krembot_ws - this folder is an example workspace for creating krembot programs. You copy it to your own workspace (see Creating New Programs.

Installation

Run the installation script:

./krembot_sim/krembot/scripts/install.sh

Uninstall

Run the uninstall script:

./krembot_sim/krembot/scripts/uninstall.sh

Sourcing setup_env.sh

This file contain argos enviorment variables, and should be sourced before using argos3. If installation script finished successfuly, it also automatically source setup_env.sh file for the first time. After that, whenever you open new terminal, you have to source the file again. This can be done by writing:

source ./krembot_sim/krembot/scripts/setup_env.sh

To avoid sourcing the file for every new terminal manually, you can add the source command to your .bashrc file.

Open Source License

MIT License

Where Do I Go From Here?

The docs/ folder contains documentation. Including the following topics:

  1. Install Krembot Woekspace
  2. Create and run new krembot program
  3. Use multiple controllers in the same program
  4. Porting files from real Krembot to simulator, and vice-versa
  5. Calibrating wheels speed
  6. Contribute
  7. Known issues

To learn more about controllers, configuration files and how argos works, refer to Argos documentation, the Argos github repository, and the Argos robot examples.