refactor(ATOM-HW-1): Creates Hardware Guide section #17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduced comprehensive documentation for Arduino Uno, ESP32 (including ESP32-CAM), and Raspberry Pi. Added introductory guides, programming instructions, basic code examples, and hardware overviews for each platform to support new users and streamline onboarding.
Added overview documentation for buttons, LEDs, motors, potentiometers, and resistors in the Components section. Introduced Raspberry Pi 4 Model B documentation, including basic Python GPIO examples, and added an overview for Raspberry Pi Zero 2 W. These additions expand the hardware guide with foundational reference material for common electronic components and Raspberry Pi boards.
Added new tutorial markdown files for various hardware components (Buttons, LEDs, Motors, Potentiometers, Resistors, Sensors) and microcontroller/computer boards (Arduino Uno, ESP32, Raspberry Pi 4, Raspberry Pi Zero 2 W). Included detailed example projects and code for Arduino, ESP32, and Raspberry Pi platforms. Removed old Raspberry Pi Zero 2 W overview and .keep files, replacing them with updated overview and tutorial content.
Renamed and relocated hardware guide documentation files from the '3D/hardware_guide' directory to 'hardware_guide' to simplify the directory structure and improve organization. No content changes were made to the files.
oEnzoRibas
requested review from
Joaoavr,
Rafaaalvess,
Copilot,
nicolasgarcia4 and
pedrolucasvsr
oEnzoRibas
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This pull request creates extensive documentation for the hardware guide, focusing on electronic components, microcontrollers, and their usage. The documentation includes detailed overviews, tutorials, and examples for various hardware components and platforms including Arduino Uno, ESP32, and Raspberry Pi systems.
- Comprehensive component documentation for buttons, LEDs, motors, potentiometers, and resistors with technical details and practical examples
- Arduino Uno programming guides and tutorials covering basic examples and advanced projects
- ESP32 and Raspberry Pi documentation including introductions, programming guides, and project tutorials
Reviewed Changes
Copilot reviewed 35 out of 37 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| hardware_guide/Components/* | Component overviews and tutorials for buttons, LEDs, motors, potentiometers, resistors, and sensors |
| hardware_guide/MicroControllers_Computers/Arduino/* | Arduino introduction, programming guide, and Uno-specific documentation with examples |
| hardware_guide/MicroControllers_Computers/ESP32/* | ESP32 introduction, programming guide, and variant-specific documentation |
| hardware_guide/MicroControllers_Computers/RaspberryPi/* | Raspberry Pi introduction, programming guide, and model-specific documentation |
Comments suppressed due to low confidence (4)
nicolasgarcia4
previously approved these changes
Aug 6, 2025
pedrolucasvsr
left a comment
pedrolucasvsr
left a comment
There was a problem hiding this comment.
Status do Repositório
Imagens
As imagens não carregaram, exceto nos arquivos:
hardware_guide/MicroControllers_Computers/RaspberryPi/Raspberry Pi 4 Model B/overview.mdhardware_guide/MicroControllers_Computers/RaspberryPi/raspberryPiZero2W/overview.md
Links (Youtube, Arduino, RaspberryPi)
- Funcionando normalmente
Renamed and reorganized various 3D model and documentation files from the root 3D directory into the Projects/3D directory structure for better organization and clarity.
Introduced overview and tutorial markdown files for 3D Printing, CAD, Power, Screens, Sensors, and Servos in the hardware guide. Expanded and updated tutorial links for Buttons, LEDs, Motors, Potentiometers, Resistors, and Sensors. Added a practice guide for servos with example Arduino code. These additions provide structured documentation and learning resources for hardware components in the project.
Removed redundant and outdated tutorial files for Arduino, ESP32, and Raspberry Pi boards. Consolidated and updated tutorial links in central 'tutorials/tutorials.md' files for Arduino and ESP32, and updated the ESP32-CAM pinout image. This improves organization and ensures up-to-date resources are provided.
Member
Author
Consertado em: |
Introduces a README file in the hardware_guide directory, providing an overview of electronic components, microcontrollers, computers, and architecting tools used in the Atom Project. This guide is intended to help newcomers understand the project's hardware ecosystem and navigate related documentation.
Joaoavr
suggested changes
Aug 6, 2025
Joaoavr
left a comment
Joaoavr
left a comment
There was a problem hiding this comment.
Apenas alterar algumas imagens que estão dando erro.
hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/basicExemples.md/tutorials.md
Outdated
Show resolved
Hide resolved
hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/overview.md
Outdated
Show resolved
Hide resolved
Added circuitDiagram.png to the media directory and updated the tutorials.md file to reference the local image instead of an external URL. This improves documentation reliability and ensures the diagram is available offline.
Joaoavr
approved these changes
Aug 7, 2025
Joaoavr
left a comment
Joaoavr
left a comment
There was a problem hiding this comment.
Descrição detalhada, tudo correto neste guia.
oEnzoRibas
added a commit
that referenced
this pull request
Aug 7, 2025
This reverts commit fe6409c.
This was referenced Aug 7, 2025
oEnzoRibas
added a commit
that referenced
this pull request
Aug 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds extensive documentation to the
hardware_guidedirectory, covering various electronic components and Arduino basics. The changes include detailed overviews, tutorials, and examples for components like buttons, LEDs, motors, potentiometers, and resistors, as well as Arduino Uno-specific content. Below are the most important changes grouped by theme:Component Documentation Enhancements:
Buttons and Switches:
hardware_guide/Components/Buttons/overview.md, hardware_guide/Components/Buttons/overview.mdR1-R62)LEDs:
hardware_guide/Components/LEDs/overview.md, hardware_guide/Components/LEDs/overview.mdR1-R62)Motors:
hardware_guide/Components/Motors/overview.md, hardware_guide/Components/Motors/overview.mdR1-R40)Potentiometers:
hardware_guide/Components/Potentiometers/overview.md, hardware_guide/Components/Potentiometers/overview.mdR1-R67)Resistors:
hardware_guide/Components/Resistors/overview.md, hardware_guide/Components/Resistors/overview.mdR1-R60)Arduino Uno Documentation:
Overview:
hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/overview.md, hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/overview.mdR1-R35)Basic Examples:
hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/basicExemples.md/examples.md, hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/basicExemples.md/examples.mdR1-R85)Tutorials:
hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/basicExemples.md/tutorials.md, hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/basicExemples.md/tutorials.mdR1-R97)Shared Tutorials:
hardware_guide/Components/Buttons/tutorials.md,hardware_guide/Components/LEDs/tutorials.md,hardware_guide/Components/Motors/tutorials.md,hardware_guide/Components/Potentiometers/tutorials.md,hardware_guide/Components/Resistors/tutorials.md,hardware_guide/Components/Sensors/tutorials.md,hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/tutorials.md, hardware_guide/Components/Buttons/tutorials.mdR1)