Skip to content

Commit

Permalink
update: what the lib do (classes changed for modules, curves added)
Browse files Browse the repository at this point in the history
  • Loading branch information
mtxslv committed Jan 15, 2023
1 parent a1d7b1d commit 509cbe7
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,24 @@ Guira is a Python Library for Robotic Simulation with CoppeliaSim (EDU 4.3.0). I
# 🤔 What does this lib do? 🤔

Guira is meant to process CoppeliaSim's basic information, such that you can focus on your robotic algorithms. Here it goes a full list of Guira's capabilities:
- Class Scene:

- Module Curves:
- Create a parametric curve (Cubic Polynomials or Lemniscate);
- Generate points over those curves.
- Module Robot:
- Actuate the robot's motors to drive it around.
- Module Scene:
- Connect to a simulation scene;
- Test if connection is ok;
- Send points to simulator;
- Get an object's (or a set of objects') handlers;
- Retrieve an object's configuration (position and orientation);
- Retrieve all objects' configurations;
- Get an object's bounding box corners' points.
- Class Robot:
- Actuate the robot's motors to drive it around.
- Class Ultrasonic:
- Module Sensors:
- Read an ultrasonic sensor.


# It seems amazing 🤩! But I have no idea how to start 😓. What should I do? 🧐

The folder `tutorials/` contain a lot of examples (each one shows an application). The folder contains both the code and the scene. You can open the scene with CoppeliaSim and run the simulation. Then you run the code with a python interpreter (the lib needs python 3.9 at least) and that is it! Here it goes a list of available examples:
Expand Down

0 comments on commit 509cbe7

Please sign in to comment.