From 509cbe7d6e5929acd9dd30ed60b55f8533a0b60e Mon Sep 17 00:00:00 2001 From: Mateus Assis Date: Sun, 15 Jan 2023 10:14:34 -0300 Subject: [PATCH] update: what the lib do (classes changed for modules, curves added) --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 87df273..e7ba972 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,13 @@ 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; @@ -13,11 +19,10 @@ Guira is meant to process CoppeliaSim's basic information, such that you can foc - 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: