Merge pull request #26 from gustavo-alberto/docs/add-bom-md

docs: Add BOM table in Markdown format
This commit is contained in:
0x23 2025-10-18 15:01:14 +02:00 committed by GitHub
commit 4ef14b9da8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 42 additions and 57 deletions

View file

@ -114,7 +114,7 @@ Please check the dimensions of your build against the values set in the construc
## ⚙ Electronics
IMPORTANT: If you fabricated PCB verion v1.2 (see version label on the board) you need to drill out a misplaced via on diode D1 that shorts 5V rail to ground (See [repair image](electronics/pcb_v1.2_fix.jpg) ). The problem was fixed in v1.3.
IMPORTANT: If you fabricated PCB version v1.2 (see version label on the board) you need to drill out a misplaced via on diode D1 that shorts 5V rail to ground (See [repair image](electronics/pcb_v1.2_fix.jpg) ). The problem was fixed in v1.3.
The electronics are designed in **KiCAD** and only commonly available modules (motor drivers and MCU boards) are used and connected by a simple PCB. No SMD soldering is required to populate the board to make the build extra accessible.
For usual winding resistance of your motors, the device should be powered by $${\color{lightgreen} 5V-6V }$$ (2A) to keep current and heating to a reasonable level.
@ -124,6 +124,10 @@ For usual winding resistance of your motors, the device should be powered by $${
<img src="images/ControllerPCB.jpg" alt="Image 2" style="flex: 1; object-fit: contain; height: 10vw;">
</div>
## ⚙ Bill of Materials (BOM)
See the full [BOM here](documentation/bom/bom.md).
## ⚙ Firmware
The firmware is written in C++ and takes some inspiration from the 'SimpleFOC' project. It aims to be streamlined and readable without any extra fuss, focusing on the hardware used in this project.