From 07031963035a33f5c51e07e7b3078b2cd3a3c9a9 Mon Sep 17 00:00:00 2001 From: Lucas Telles Date: Wed, 2 Jul 2025 23:51:32 -0300 Subject: [PATCH 1/2] Update README.md README file updated with more information about the repository and instructions to download it to a local storage. --- README.md | 52 ++++++++++++++++------------------------------------ 1 file changed, 16 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index b296593..8a838d6 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,12 @@ This repository contains the source code and computational components of the Rob ## 🎯 Objectives -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. +This repository contains the **hardware** 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 electronics, and software, this repository focuses specifically on the mechanical and solid parts. The repository includes all source code related to: -- 🧠 **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 - -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. +- 🧠 **Forearm, wrist and hand building**, using 3D printed pieces and electronical components. +- πŸ“‘ **Connection with Arduino**, we'll use cable connections to communicate with the arduino board. --- @@ -27,45 +23,29 @@ This software is a core component of the ATOM Project and is continually evolvin ## πŸ“‚ 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 +β”œβ”€β”€ πŸ“‚ scripts # Needed scripts to the github project organization β”œβ”€β”€ πŸ“„ LICENSE # Project MIT license β”œβ”€β”€ πŸ“„ README.md # Main repository documentation -└── πŸ“„ requirements.txt # Python dependencies list ``` --- -## βš™οΈ Installation Guide - ### Prerequisites +- Git version 2.25 or higher +- Access to a terminal/command line -- Arduino IDE 2.0+ -- Python 3.8+ -- 3D Printer (recommended configuration: 0.2mm layer height, 20% infill) -- OpenCV 4.7.0 -- CVZone 1.5.6 - -### Setup +### Steps ```bash +# 1. Clone the repository without checking out files +git clone --filter=blob:none --no-checkout https://github.com/username/repository.git +cd repository -# 1. Clone the repository -git clone https://github.com/ATOM-Arm/software -cd braco-robotico - -# 2. Install Python dependencies -pip install -r requirements.txt -# The file includes: -# opencv-python==4.7.0.72 -# cvzone==1.5.6 -# pyserial==3.5 +# 2. Enable sparse checkout +git sparse-checkout init --cone -# 3. Open Arduino IDE and load the code from software.dsp/arduino +# 3. Set the folder you want to download +git sparse-checkout set path/to/folder -# 4. Upload the code to your Arduino board - -# 5. Run the Python scripts in software.dsp/python - -``` +# 4. Checkout the content +git checkout From c847eff40f45959ec7f6c7813876d71a1aaecc6a Mon Sep 17 00:00:00 2001 From: Lucas Telles Date: Thu, 3 Jul 2025 15:49:46 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a838d6..2dcd78d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# πŸ“š Robotic Arm – Software Repository +# πŸ“š Robotic Arm – Hardware 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. +This repository contains the 3D models and solid components of the Robotic Arm with Computer Vision project. It focuses on the hardware build and connection with Arduino board. [![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)