- Welcome to place-bot
- Simple-Playgrounds
- Installation
- Elements of the environment
- Programming
- Contact
Place-bot is the environment that simulates a robot and his sensors.
Access to the GitHub repository Place-bot
This program Place-bot is an extension of the Simple-Playgrounds (SPG) software library: https://github.com/mgarciaortiz/simple-playgrounds. However, in the current installation of Place-bot, it is the branch place-bot of a fork of Simple-Playgrounds that is used: https://github.com/emmanuel-battesti/simple-playgrounds.
It is recommended to read the documentation of Simple-Playgrounds.
Simple-Playgrounds is an easy-to-use, fast and flexible simulation environment. It bridges the gap between simple and efficient grid environments, and complex and challenging 3D environments. It proposes a large diversity of environments for embodied robots learning through physical interactions. The playgrounds are 2D environments where robots can move around and interact with scene elements.
The game engine, based on Pymunk and Arcade, deals with simple physics, such as collision and friction. Robots can act through continuous movements and discrete interactive actions. They perceive the scene with realistic first-person view sensors, top-down view sensors, and semantic sensors.
In Simple-Playgrounds, the game engine used is Arcade. The robot enters a Playground, and starts acting and perceiving within the environment. The perception/action/communication loop is managed by the game engine. At each time step, all perception is acquired. Then according to actions to do, robot is moved. Everything is synchronized, unlike what you would get on a real robot.
In Simple-Playgrounds, the 2D physics library Pymunk is used. The physics engine handles simple physics, such as collision and friction. This gives a mass and inertia to all objects.
If you need to modify the code of this library, you will have to install it to work comfortably.
The INSTALL.md file contains installation tips for Ubuntu and Windows.
Robot is a version of what is called agent in Simple-Playgrounds. Robot is composed of different body parts attached to a Base.
Robot perceives his surroundings through a first-person view sensor : the Lidar sensor.
Robot is equipped with an odometry sensor that allow it to estimate its position and orientation. The odometer provides us current position and orientation relative to the first position of the robot.
In the code, class Lidar, in the file src/place_bot/entities/lidar.py
It emulates a lidar.
- fov (field of view): 360 degrees
- resolution (number of rays): 181
- max range (maximum range of the sensor): 300 pixels
A gaussian noise is added to the distance measurements. As the field of view (fov) is 360°, the first (at -Pi rad) and the last value (at Pi) should be the same.
To visualize lidar sensor data, you should set the parameter draw_lidar parameter of the Simulator class to True.
In the file src/place_bot/entities/odometer.py, it is described in the class Odometer.
This sensor returns an array of data containing the pose of the robot by integrating its displacement at each step. Its displacement is :
- dist_travel, the distance of the robot's movement during the last timestep.
- alpha, the relative angle of the current position with respect to the previous reference frame of the robot
- theta, the orientation variation (or rotation) of the robot during the last step in the reference frame
Gaussian noise was added separately to the three parts of the data to make them look like real noise.
We use those noisy odometry data by integrating measurements over time to finally get an estimate of the current position of the robot.
If you want to enable the visualization of the noises, you should set the parameter enable_visu_noises to True. It will show also a demonstration of the integration of odometer values, by drawing the estimated path.
At each time step, you must provide values for your actuators.
You have 2 values to move your robot:
- forward_controller, a float value between -1 and 1. This is a force apply to your robot in the longitudinal way.
- angular_vel_controller, a float value between -1 and 1. This is the speed of rotation.
You can find examples of actuator use in almost all files in examples/.
Robot act and perceive in a Playground.
A playground is composed of scene elements, which can be fixed or movable. The playground with all its elements, except for the robot, are called "World" within this Place-bot repository.
A playground is described using a Cartesian coordinate system.
Each element has a position (x,y, theta), with x along the horizontal axis, y along the vertical axis, and theta the orientation in radians, aligned on the horizontal axis. The position (0, 0) is at the center of the world. The value of theta is between -Pi and Pi. Theta increases with a counter-clockwise rotation of the robot. For theta = 0, the robot is oriented towards the right. A playground has a size [width, height], with the width along x-axis, and height along y-axis.
As its name indicates, this folder contains the code of the place_bot simulator. It contains three main subdirectories:
- entities: contains description of different entities used in the program.
- simu_world: contains description of default world and the simulator interface.
- utils: contains various functions and useful tools.
We have also two others directories:
- resources: contains the image for the sprite of the robot and the texture of the walls.
- tools: contains tools to create complex worlds automatically.
An important file is the simu_world/simulator.py which contains the class Simulator. If you want to use the keyboard to move the first robot, you should set the parameter use_keyboard to True. If you want to enable the visualization of the noises, you should set the parameter enable_visu_noises to True. It will show also a demonstration of the integration of odometer values, by drawing the estimated path.
In the folder, you will find stand-alone programs to help you program with examples. In particular:
- display_lidar.py shows a visualization of the lidar on a graph. You can see the noise added.
- example_keyboard.py shows how to use the keyboard for development or debugging purpose. The usable keyboard keys :
- up / down key : forward and backward
- left / right key : turn left / right
- l key : display (or not) the lidar sensor
- q key : exit the program
- r key : reset
examples/example.py is the main example file to launch a robot using your code.
It will launch the robot that you will have customized in the world that you want, make it run.
This file needs almost no modification to work, except those lines at the beginning of the file:
class MyWorld(MyWorldComplete01):
pass
class MyRobot(MyAwesomeRobot):
passMyWorld must inherit from the class of the world you want to use (here, in the example MyWorldComplete01). This world will be located in the folder examples/worlds.
MyRobot must inherit from the class of the robot that you created (here, in the example, your awesome robot MyAwesomeRobot). This robot will be located in the folder examples/robots.
This directory contains the worlds in which the robot can move. They are only used here as examples. You can make your own worlds based on existing ones.
Each world must inherit from the class WorldAbstract.
This directory contains some robots. They are only used here as examples. By taking inspiration from what is there and going beyond it, you will implement the code that will define your robot and the way it interacts with its environment.
Each Robot must inherit from the class RobotAbstract. You have one mandatory member functions: control() that will give the action to do for each time step.
For your calculation in the control() function, it is mandatory to use only the sensor without directly accessing the class members. In particular, you should not use the position and angle variables, but you should compute an estimated position and orientation of the robot from the odometry data. These values are noisy, representing more realistic sensors.
The true position of the robot can be accessed with the functions true_position() and true_angle() (or directly with the variable position and angle), BUT it is only for debugging or logging.
Some examples are provided:
- my_robot_random.py shows the actuators
- To exit elegantly after launching a world, press 'q'.
If you have questions about the code, you can contact: emmanuel . battesti at ensta-paris . fr