From 1ab1f540bf1c3eea934d158af9b254fa8c4af6b0 Mon Sep 17 00:00:00 2001 From: Pedro Ramalho Date: Thu, 19 Jun 2025 15:48:01 -0300 Subject: [PATCH] Update README.md --- README.md | 108 +++++++++++++++++++++--------------------------------- 1 file changed, 41 insertions(+), 67 deletions(-) diff --git a/README.md b/README.md index e3f6a22..b296593 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,71 @@ -# 🤖 Braço Robótico com Visão Computacional -**Sistema mecatrônico articulado controlado por gestos humanos via OpenCV e Arduino** -*(Projeto GIC - Centro Universitário Dom Helder Câmara | 2025)* +# 📚 Robotic Arm – Software Repository + +This repository contains the source code and computational components of the Robotic Arm with Computer Vision project. It focuses on the software system responsible for gesture recognition, motor control, and integration with Arduino hardware. [![Licença MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) [![Video Demo](https://img.shields.io/badge/YouTube-Demonstração-red)](https://youtu.be/4t1daCFQ1OE) -[![OpenCV](https://img.shields.io/badge/OpenCV-4.7.0-blue)](https://opencv.org) +[![OpenCV](https://img.shields.io/badge/OpenCV-4.7.0-blue)](https://opencv.org) --- -## 📜 Resumo do Projeto -Solução robótica baseada no modelo **articulado** (Groover, 2011) com: -- 👁️ Visão computacional para rastreamento de gestos (CVZone/OpenCV) -- 🦾 Peças personalizadas em impressão 3D (PLA/ABS) -- 🧠 Controle inteligente via Arduino (C++) e Python -- 📚 Documentação acadêmica completa +## 🎯 Objectives -**Palavras-chave**: Robótica, Visão Computacional, Arduino, OpenCV, Impressão 3D +This repository contains the **software system** of the **ATOM Project**, a robotic arm controlled through computer vision and built using 3D printing and open-source hardware. While the overall project integrates mechanics, electronics, and software, this repository focuses specifically on the **computational logic** that enables intelligent control and visual interaction. ---- +The repository includes all source code related to: -## 🎯 Objetivos -### Geral -Desenvolver um braço robótico que interprete cenários visuais e execute tarefas autônomas (ROSÁRIO, 2010) +- 🧠 **Computer vision and gesture recognition**, powered by OpenCV and CVZone +- 📡 **Communication with Arduino**, for controlling servo motors via serial interface +- ⚙️ **Control algorithms and system logic** written in Python +- 🧪 **Testing scripts and prototypes** of the vision-control pipeline -### Específicos -- ✅ Integrar impressão 3D na fabricação de peças -- ✅ Implementar módulos mecânicos/eletrônicos -- ✅ Desenvolver algoritmos de rastreamento com CVZone -- ✅ Testar precisão em manipulação de objetos -- ✅ Documentar para replicação acadêmica +This software is a core component of the ATOM Project and is continually evolving to support research, experimentation, and educational development in robotics and automation. --- + ``` -## 📂 Estrutura de Pastas -📦 braco-robotico -├── 📂 docs # Documentação acadêmica e relatórios -│ ├── 📄 especificacoes.pdf # Requisitos do sistema -│ └── 📄 manual_tecnico.md # Guia de implementação -├── 📂 firmware # Código Arduino -│ ├── 📄 braco_robotico.ino # Sketch principal -│ └── 📄 pid_controller.h # Biblioteca de controle -├── 📂 modelos_3d # Arquivos para impressão -│ ├── 📄 base.stl # Peça estrutural -│ ├── 📄 garra.stl # Módulo de preensão -│ └── 📄 articulacoes/ # Conjunto de eixos -├── 📂 src # Código Python -│ ├── 📄 main.py # Script de visão computacional -│ ├── 📄 gesture_tracker.py # Lógica de rastreamento -│ └── 📄 serial_com.py # Comunicação Arduino -├── 📂 testes # Scripts de validação -│ ├── 📄 calibracao.py # Ajuste de servomotores -│ └── 📄 precision_test/ # Dataset de validação -├── 📄 LICENSE # Licença MIT -└── 📄 README.md # Documentação principal +## 📂 Folder Structure +📦 software +├── 📂 .github # GitHub integration workflows and configs +├── 📂 software.dsp # Main computational system source code +│ ├── 📂 arduino # Embedded code for servo control +│ └── 📂 python # Python scripts for vision and control +├── 📄 LICENSE # Project MIT license +├── 📄 README.md # Main repository documentation +└── 📄 requirements.txt # Python dependencies list ``` + --- -## 🛠️ Arquitetura do Sistema -### Hardware -| Componente | Especificações | -|--------------------------|----------------------------------------| -| **Arduino Uno/Nano** | Controle PID dos servomotores | -| **Servomotores MG996R** | 10kg/cm torque, 180° rotação | -| **Logitech C920** | 1080p @ 30fps para rastreamento | -| **Peças 3D** | Modelos InMoov (STL disponíveis [aqui](#-apêndice)) | - -### Software -| Camada | Tecnologias | -|-----------------|--------------------------------------| -| **Visão** | Python 3.8+, OpenCV 4.7, CVZone 1.5 | -| **Controle** | C++ (Arduino IDE), PlatformIO | -| **Comunicação** | Protocolo Serial @ 115200 baud | +## ⚙️ Installation Guide ---- +### Prerequisites -## ⚙️ Guia de Instalação -### Pré-requisitos - Arduino IDE 2.0+ - Python 3.8+ -- Impressora 3D (configuração recomendada: 0.2mm layer height, 20% infill) +- 3D Printer (recommended configuration: 0.2mm layer height, 20% infill) +- OpenCV 4.7.0 +- CVZone 1.5.6 ### Setup + ```bash -# 1. Clonar repositório -git clone https://github.com/domhelder-gic/braco-robotico.git + +# 1. Clone the repository +git clone https://github.com/ATOM-Arm/software cd braco-robotico -# 2. Instalar dependências Python +# 2. Install Python dependencies pip install -r requirements.txt -# Arquivo inclui: +# The file includes: # opencv-python==4.7.0.72 # cvzone==1.5.6 # pyserial==3.5 -# 3. Programar Arduino -arduino-cli compile --fqbn arduino:avr:nano firmware/braco_robotico.ino \ No newline at end of file +# 3. Open Arduino IDE and load the code from software.dsp/arduino + +# 4. Upload the code to your Arduino board + +# 5. Run the Python scripts in software.dsp/python + +```